Lighty is a lightweight, efficient boilerplate for Node.js applications, providing a solid starting point for building your Node.js projects with best practices in mind.
- Installation
- Features
- Usage
- Contributing
- License
- Acknowledgments
To get started with Lighty, clone the repository and install the dependencies:
git clone https://github.com/aboudzz/lighty.git
cd lighty
npm install nodemon forever -g
npm install --save-dev run-script-os- Fast Setup: Get your Node.js project up and running in no time.
- Best Practices: Includes configurations for linting, testing, and more.
- Scalability: Structured to support growth as your project expands.
After installation, you can deploy the database and then start the development server with:
npm run mongo:deploy
npm run start:development
For production environments, run:
npm run start:production
We welcome contributions! Please follow these steps to contribute:
- Fork the repository.
- Create a new branch:
git checkout -b my-new-feature. - Make your changes.
- Commit your changes:
git commit -am 'Add some feature'. - Push to the branch:
git push origin my-new-feature. - Submit a pull request.
This project is licensed under the ISC License - see the LICENSE.md file for details.
- Thanks to all the contributors who invest their time into making Lighty better.
- Special thanks to the Node.js community for their continuous support.
- Thanks to ChatGPT for generating this README.md file.