source-beb
v1.0.3
Published
Create a Back-End Project with Node.js, Express, and MongoDB in one command.
Maintainers
Readme
BeB
This CLI tool generates a fully organized backend project structure using Express and MongoDB. It provides a simple command-line interface to create a new project with all the necessary files and configurations.
Features
- Project Structure: Automatically creates a well-organized directory structure for your Express and MongoDB application.
- Configuration Files: Generates essential configuration files, including database connection settings and environment variables.
- Middleware: Includes authentication and error handling middleware to streamline your development process.
- Controllers and Services: Sets up templates for controllers and services to help you manage your application logic effectively.
- TypeScript Support: The generated project is fully compatible with TypeScript, ensuring type safety and better development experience.
- CommonJS Support: The generated project is also can be in the old javascript for the OGs
Installation
You can install the CLI via npm or yarn:
npm install -g source-bebyarn global add source-bebUsage
To generate a new Backend project using BeB, run the following command:
# Initialize the CLI tool
beb init# Generate a new project
beb generate <project-name>Replace <project-name> with the desired name for your new project.
Then Choose Between CommonJS and TypeScript by type 1 Or 2
Project Structure
The generated project will have the following structure:
TypeScript Version
<project-name>
├── src
│ ├── config
│ │ ├── database.ts
│ │ └── index.ts
│ ├── controllers
│ │ └── index.ts
│ ├── middleware
│ │ ├── auth.ts
│ │ └── error.ts
│ ├── models
│ │ └── index.ts
│ ├── routes
│ │ └── index.ts
│ ├── services
│ │ └── index.ts
│ ├── utils
│ │ └── index.ts
│ ├── app.ts
│ └── server.ts
├── .env.example
├── .gitignore
├── package.json
└── README.mdCommonJS Version
<project-name>
├── src
│ ├── config
│ │ ├── database.js
│ │ └── index.js
│ ├── controllers
│ │ └── index.js
│ ├── middleware
│ │ ├── auth.js
│ │ └── error.js
│ ├── models
│ │ └── index.js
│ ├── routes
│ │ └── index.js
│ ├── services
│ │ └── index.js
│ ├── utils
│ │ └── index.js
│ ├── app.js
│ └── server.js
├── .env.example
├── .gitignore
├── package.json
└── README.mdContributing
If you have suggestions or improvements, feel free to open issues or pull requests. We welcome contributions!
Bugs and Issues
If you encounter any bugs or issues, please open an issue on the GitHub repository.
Created with ❤️ by Odqin
