https://github.com/odqin/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.
https://github.com/odqin/beb
api backend buidler cli express expressjs npm package
Last synced: 3 days ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/odqin/beb
- Owner: odqin
- License: mit
- Created: 2025-06-02T20:59:34.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-07-01T01:44:38.000Z (3 months ago)
- Last Synced: 2025-07-01T02:36:45.223Z (3 months ago)
- Topics: api, backend, buidler, cli, express, expressjs, npm, package
- Homepage: https://www.npmjs.com/package/source-beb
- Size: 28.3 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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](https://www.npmjs.com/package/source-beb) or yarn:
```bash
npm install -g source-beb
```
```bash
yarn global add source-beb
```
## Usage
To generate a new Backend project using BeB, run the following command:
```bash
# Initialize the CLI tool
beb init
```
```bash
# Generate a new project
beb generate
```
Replace `` 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
```
├── 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.md
```
### CommonJS Version
```
├── 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.md
```
## Contributing
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](https://github.com/odqin/BeB).
Created with ❤️ by [Odqin](https://github.com/odqin/)
[](https://www.npmjs.com/package/source-beb)
[](https://www.npmjs.com/package/source-beb)
[](https://www.npmjs.com/package/source-beb)
[](https://github.com/odqin/BeB)