xpress-init
v1.1.1
Published
A simple CLI tool to set up an Express.js application
Maintainers
Readme
xpress-init
🚀 xpress-init is a simple tool to set up a fully functional Express.js app with a single command.
Features
- Quickly bootstrap an Express.js app.
- Clones a pre-configured Express.js template from the express-setup repository.
- Includes:
- Pre-configured routes, controllers, and middleware.
- Environment variable setup.
- JWT-based authentication.
- MongoDB integration.
Installation
You don't need to install anything globally! Use it directly with npx:
npx xpress-initUsage
- Run the following command:
npx xpress-init - Follow the prompts to:
- Enter your project name.
- Wait while the app is set up, and dependencies are installed.
- Navigate to your project directory and start the server:
cd <your-project-name> npm start
Example
npx xpress-init
# Enter your project name: my-awesome-app
# Cloning the repository...
# Installing dependencies...
# Setup complete!Template Repository
The Express app is based on express-setup. It includes all the necessary features to kickstart your project:
- Express.js framework.
- MongoDB integration using
mongoose. - JWT authentication.
- Environment variable management.
- Logging with
morganandwinston. - CORS enabled by default.
- Development auto-reload with
nodemon.
For more details about the template, visit the express-setup README.
Contributing
Contributions are welcome! To contribute:
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch). - Commit your changes (
git commit -m 'Add feature'). - Push to the branch (
git push origin feature-branch). - Open a Pull Request.
License
This project is licensed under the ISC License. See the LICENSE file for details.
Author
Anik Adhikari
For any inquiries, feel free to reach out via GitHub or open an issue in the repository.
