Code Monkey home page Code Monkey logo

quick-nodejs-starter's Introduction

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
  • 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 - [email protected]

quick-nodejs-starter's People

Contributors

abdoutelb avatar netcode avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

abdoutelb

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.