https://github.com/amanbig/backtool
A CLI tool to generate backend structures for Node.js applications with support for multiple databases and a visually appealing user interface.
https://github.com/amanbig/backtool
bycryptjs cors express hacktoberfest javascript mongodb mysql npm npm-package postgresql sqlite typescript
Last synced: about 2 months ago
JSON representation
A CLI tool to generate backend structures for Node.js applications with support for multiple databases and a visually appealing user interface.
- Host: GitHub
- URL: https://github.com/amanbig/backtool
- Owner: Amanbig
- License: mit
- Created: 2025-05-04T08:26:38.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-12-28T11:40:13.000Z (5 months ago)
- Last Synced: 2026-03-30T02:44:32.542Z (2 months ago)
- Topics: bycryptjs, cors, express, hacktoberfest, javascript, mongodb, mysql, npm, npm-package, postgresql, sqlite, typescript
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/backtool
- Size: 158 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# BackTool
A CLI tool to generate backend structures for Node.js applications with support for multiple databases and a visually appealing user interface.
## Overview
BackTool simplifies the process of setting up a Node.js backend by generating a complete project structure, including a server entry point, models, database configuration, controllers, routes, middleware, and a customized `package.json`. It supports MongoDB, PostgreSQL, MySQL, and SQLite, allowing developers to quickly scaffold a backend tailored to their preferred database.
## Features
- **Docker Support**: Generates `Dockerfile` and `docker-compose.yml` tailored to the selected database.
- **Linting & Formatting**: Optional setup for `ESLint` and `Prettier` for code quality.
- **Security & Logging**: Includes `helmet` for security headers and `morgan` for request logging by default.
- **Environment Configuration**: Includes `.env.example` template that gets copied to `.env` for easy environment setup.
- **Database Support**: Generates configurations and models for MongoDB, PostgreSQL, MySQL, and SQLite.
- **Improved Model Interfaces**: Standardized models for consistent usage across all databases.
- **File Overwrite Protection**: Prompts users before overwriting existing files (e.g., `server.js`, `package.json`, model files).
- **Extensible**: Easily add new databases or structure components by updating the template folder.
## Installation
Install BackTool globally to use it from any directory:
```bash
npm install -g backtool
```
Alternatively, clone the repository and link it locally:
```bash
git clone https://github.com/Amanbig/backtool.git
cd backtool
npm install
npm link
```
## Usage
### Interactive Mode
Run BackTool without arguments to use interactive prompts:
```bash
backtool
```
or directly using:
```bash
npx backtool@latest
```
This will display an ASCII banner and prompt for:
- Project name (e.g., `my-app`)
- Database choice (MongoDB, MySQL, PostgreSQL, or SQLite)
### Non-Interactive Mode
Specify options directly to skip prompts:
```bash
backtool --project my-app --database MongoDB
```
### Options
- `-p, --project `: Specify the project name (default: `my-app`).
- `-d, --database `: Specify the database (MongoDB, MySQL, PostgreSQL, SQLite).
- `-l, --language `: Specify the language (JavaScript, TypeScript).
- `-f, --force`: Force overwrite of existing files without prompting.
- `-u, --uri `: Specify database connection URI.
- `--docker`: Generate Dockerfile and docker-compose.yml.
- `--linter`: Configure ESLint and Prettier.
- `-v, --version`: Display the version number.
- `-h, --help`: Show help information.
## Generated Structure
Running BackTool creates one of the following directory structures based on the chosen language:
### JavaScript Structure
```
my-app/
├── server.js
├── package.json
├── .env
├── .gitignore
├── config/
│ └── database.js
├── models/
│ └── user..js
├── controllers/
│ └── authController.js
├── routes/
│ └── auth.js
├── middleware/
│ └── auth.js
├── node_modules/
└── .git/
```
### TypeScript Structure
```
my-app/
├── server.ts
├── package.json
├── tsconfig.json
├── .env
├── .gitignore
├── src/
│ ├── config/
│ │ └── database.ts
│ ├── models/
│ │ └── user..ts
│ ├── controllers/
│ │ └── authController.ts
│ ├── routes/
│ │ └── auth.ts
│ ├── middleware/
│ │ └── auth.ts
│ └── types/
│ └── express.d.ts
├── dist/ # Compiled JavaScript
├── node_modules/
└── .git/
```
- **server.[js|ts]**: Entry point for the Node.js application, setting up the Express server and routes.
- **package.json**: Includes project configuration, scripts, and dependencies. For TypeScript projects, includes additional scripts for building and type checking.
- **tsconfig.json**: (TypeScript only) TypeScript compiler configuration.
- **config/database.[js|ts]**: Database connection and table initialization.
- **models/**: Database models with database-specific implementations.
- **controllers/**: Request handling logic including authentication.
- **routes/**: API route definitions.
- **middleware/**: Custom middleware (e.g., authentication).
- **types/**: (TypeScript only) Type definitions and declarations.
- **dist/**: (TypeScript only) Compiled JavaScript output.
The `users` table/model includes fields: `id`, `username`, `email`, `password`, and `created_at`.
## Running the Application
After generating the project, navigate to the project directory and run:
```bash
# For JavaScript projects
npm start
# For TypeScript projects
npm start # Runs with ts-node
npm run build # Compiles TypeScript to JavaScript
npm run start:prod # Runs the compiled JavaScript
```
For development with auto-restart on file changes:
```bash
npm run dev # Works for both JavaScript and TypeScript
```
## Supported Databases
- **MongoDB**: Uses `mongoose` for schema-based modeling.
- **PostgreSQL**: Uses `pg` with a connection pool and SQL queries.
- **MySQL**: Uses `mysql2` with a promise-based connection pool.
- **SQLite**: Uses `sqlite3` and `sqlite` for lightweight, file-based storage.
## Dependencies
BackTool installs the following dependencies in the generated project:
### Common Dependencies
- **Core Dependencies**: `express`, `dotenv`, `cors`, `jsonwebtoken`, `helmet`, `morgan`
- **Database-specific Dependencies**:
- MongoDB: `mongoose`, `bcryptjs`
- PostgreSQL: `pg`, `bcryptjs`
- MySQL: `mysql2`, `bcryptjs`
- SQLite: `sqlite3`, `bcryptjs`
### Development Dependencies
- **Common**: `nodemon`
- **TypeScript-specific** (when TypeScript is selected):
- `typescript`
- `ts-node`
- `@types/node`
- `@types/express`
- `@types/cors`
- `@types/jsonwebtoken`
- `@types/bcryptjs`
- Database-specific types (e.g., `@types/mongoose`, `@types/pg`)
## Development
To contribute or modify BackTool:
1. Clone the repository:
```bash
git clone https://github.com/Amanbig/backtool.git
```
2. Install dependencies:
```bash
npm install
```
3. Update the `backtool_folder` directory with custom templates (e.g., `server.js`, models).
4. Test locally:
```bash
npm link
backtool --project test-app --database SQLite
```
[](https://buymeacoffee.com/amanpreet)
## License
MIT License
## Contact
For issues or feature requests, open a ticket on the [GitHub repository](https://github.com/Amanbig/backtool).