Quick Start Express

A simple CLI tool to generate Express servers from multiple available templates. View on NPM

Commands

Version

View current tool version.

qse -v

qse --version

Output

List

List all available commands and options.

qse list

Output

Init

Initialize a new Express.js server.

Run the below command after installing the tool in the directory in which you want the template to be created.

qse init

Select a template

Answer a few questions to customize your template

Output

Initialize an Express.js server template (directly with flags).

qse init -t template_name

Output

Initialize with a Docker Compose file and Dockerfile.

qse init -t template_name --docker-compose

Output

Initialize without nodemon.

qse init -t template_name --remove-nodemon

Output

Initialize without installation of dependencies.

Initialize a new Express.js server without installing dependencies.

qse init template_name --remove-deps

Output

Customize the Generated Server App Name

Set a custom name for your generated Express server application during initialization.

qse init -t basic -n app_name

Output

Clear

Clear Directory.

qse clear

Output

Install Package from npm

1. Run the following command in the terminal to install the required node packages:

npm i -g quick_start_express

2. Run any qse commands in the target directory such as qse init, qse clear, qse -v ... etc.

Contributing

Follow the guidelines in CONTRIBUTING.md to contribute to the project.

Local Development Environment Setup

Install Node.js

1. Download and install Node.js from https://nodejs.org/

2. Verify the installation by running the following command in the terminal:

   node -v

   The version of Node.js should be displayed.

Install node packages.

1. Run the following command in the terminal to install the required node packages:

   npm i

Run the package.

To test the CLI tool locally, you need to link the package. Use a separate testing directory to avoid modifying files in the root directory of quick_start_express.

1. Link the Package in the Main Directory: In the quick_start_express root directory, run:

   npm link

2. Create a Testing Directory: In the quick_start_express root directory, create a qse-test directory:

   mkdir qse-test
   cd qse-test

3. Link qse in the Testing Directory: In the testing directory, run:

   npm link qse

4. Run qse Commands: Now, you can execute any qse commands in the testing directory, such as:

   qse init
   qse clear
   qse -v

Note

Running npm link qse in the root directory may modify package.json. Always use a separate testing directory to avoid this.

Clean-Up: After testing, you may delete the testing directory if it’s no longer needed.

Running Tests

To execute the tests, navigate to the root directory of the quick_start_express project where all dependencies are installed, and run the following command:

npm test

Core Contributors

• Abhinav Ramakrishnan
• Ashwin Narayanan S

Contributors

• Harish G M
• Kiran Rajeev
• Adripo
• Akshay K S
• Jayadev D
• K Venkatesh
• Vaibav
• Pavan Prakash K
• Adithya Menon R
• Phuong Thuy Nguyen
• Abhinav Bansal
• Guilherme Almeida Lopes
• Nitansh Shankar
• Priyansh Narang