project-node-setup

A Node.js project scaffold that helps you quickly set up a new project with essential configurations such as Express, Redis, MongoDB, S3, JWT Authentication, and Logging (Winston).

Features

• Express: A minimal and flexible Node.js web application framework.
• Redis: A powerful in-memory data store for caching and message brokering.
• MongoDB: A NoSQL database for modern applications.
• S3: Integration with AWS S3 for object storage.
• JWT Authentication: JSON Web Token authentication for secure APIs.
• Logging (Winston): A versatile logging library for Node.js.

Installation

To create a new Node.js project scaffold, follow these steps:

1. Install the package globally:

   npm install -g project-node-setup

2. Run the setup command:

   After installing, run the following command to start the project setup:

   create-node-app

   This will prompt you for the following inputs:

   • Project Name: The name of your new project.
   • Features: Select the features you want to include (Express, Redis, MongoDB, etc.).

Generated Project Structure

After running the setup command, a basic project structure will be created:

MIT License

Copyright (c) [2024] [Sandeep Sheoran]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is provided to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contributors

Sandeep Sheoran