alexandercarson / express-api-cli

Express-api-cli is a command line tool that generates an express project structure preconfigured with most commonly used packages that can spped up your development workflow.

---

npm install -g express-api-cli

speed up your application development with express-api-cli

About

Express-api-cli is a command line tool that generates an express project structure preconfigured with most commonly used packages that can speed up your development workflow. Rather than wasting time setting up your project structure, express-api-cli does the heavy lifting so that you can concentrate on building that awesome application

Features

• Preconfigured database driver (Mongoose and Sequelize)
• Typescript support
• Generate Models, Controllers, Routes, Services and Test files directly from the command
• Easy exception handling
• Beautiful clear code structure
• Integrated Testing tool
• Eslint and Prettier Formatting
• Integrated Basic Security e.t.c

Getting Started

1. Ensure Node.js and NPM is installed on your computer

2. Install the package globally npm install -g express-api-cli

3. Open your command line tool and type the following command to create a new project exp-api create awesome-project

   Subsitute "awesome-project" with the name of your project.

4. Select your preferred language (Javascript or Typescript) and Database Driver (Mongoose or Sequelize)

5. Once project is installed, configure your environment variables

Voila!!! you are set to start creating an awesome application 🚀🚀🚀

Commands

Commands	Description	Example
create	Creates a new project	exp-api create awesome-project
-m or --model	Create a new model in the model directory	exp-api -m post
-c or --controller	Create a new controller in the controller directory	exp-api -c post
-s or --service	Create a new service in the service directory	exp-api -s post
-r or --route	Create a new route in the route directory	exp-api -r post
-R or --resource	Create a new route, model, controller and service in their respective directories	exp-api -R post
-u or --utility	Create a new utility file in the utils directory	exp-api -u random-string
-M or --middleware	Create a new middleware in the middleware directory	exp-api -M auth
-V or --validator	Create a new validator file in the validator directory	exp-api -v user-validator
-v or --version	Get express-api-cli version	exp-api -v
-i or --interface	Create a new interface file in the interface directory (Available only on Typescript)	exp-api -i post
-U or --unittest	Create a new unit test file in the test directory	exp-api -U post
-I or --integrationtest	Create a new integration test file in the test directory	exp-api -I post
-T or --test	Create new unit and integration test	exp-api -U post
-C or --config	Create a new config file in the config directory	exp-api -C mail