/node-skeleton

on go node js repo

Primary LanguageJavaScriptMIT LicenseMIT

Quick Nodejs Starter Template

Quick and simple nodejs starter application template for your next project

Node.js CI MIT License Issues

About The Project

I needed a very simple structure for small nodejs applications, so i made one for my own use without too many plugins or over complication on folder structure.

Built With

  • Express - Server framework.
  • Dotenv - To manage environment variables across environments.
  • Debug - Debug without console.log.
  • Jest - Testing framework.
  • Nodemon - Monitor for any changes in your node.js application and automatically restart it.
  • eslint - Find and fix problems in your JavaScript code.
  • prettier - Format code with guidlines.
  • husky - Manage pre-commit/pre-post git hooks.

Using Docker

  • For Development
docker-compose -f docker-compose-dev.yml up --build
  • For Production
docker-compose up --build

Installation (local)

  1. Install dependencies
yarn install
  1. Copy .env.example into .env and edit its content to fit your case.
  2. Run in dev mode
yarn dev

Installation (production)

  1. Install dependencies
yarn install --production
  1. Copy .env.example into .env and edit its content to fit your case.
  2. Start it using your fav tool ( recommend pm2 )
yarn start

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Eslam Salem - @net_code - eslam@shieldfy.com