Node API Boilerplate

✨ A simple and quick way to start your API using NodeJS + Express.

Requirements

• NodeJS;
• Yarn;

Getting Started

The most quickly way to start your project is following the example:

# Get the latest snapshot
$ git clone git@github.com:helderburato/node-api-boilerplate.git ~/<your-project>

# Change directory
$ cd <your-project>

# Install dependencies
$ yarn install

# Start your project
$ yarn dev OR yarn start // => DEV / PROD

Note: To set your environment variables you need to duplicate the file .env.example and rename to .env.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Helder Burato Berto - Initial work - helderburato

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.