Server Package CLI

A command-line tool to quickly scaffold server projects with JavaScript or TypeScript templates.

Installation

npx create-uk-node-server

The tool will prompt you to:

1. Choose your preferred language (JavaScript or TypeScript)
2. Enter your project name

What it does

This tool creates a new server project with:

• Express.js setup
• Basic folder structure (controllers, middlewares, models, routes, utils)
• Database configuration
• Environment variables setup
• Basic routing structure

Project Structure

After running the tool, you'll get a project with this structure:

your-project/
├── src/
│   ├── config/
│   │   └── db.config.js
│   ├── controllers/
│   │   └── index.controller.js
│   ├── middlewares/
│   │   └── errorHandler.js
│   ├── models/
│   │   └── user.model.js
│   ├── routes/
│   │   └── index.route.js
│   │   └── user.route.js
│   └── utils/
│       └── general.js
├── .env
├── .gitignore
├── index.js
├── package-lock.json
└── package.json

Getting Started

1. Run the CLI tool

2. Choose your language preference

3. Enter your project name

4. Navigate to your project directory

5. Create .env file

   APP_ENV=development
   PORT=3000
   APP_URL=http://localhost:3000
   DB_URL=mongodb://localhost:27017/your-database

6. Run npm start to start your server

License

ISC

Contributing

Feel free to submit issues and enhancement requests!