https://github.com/helderberto/node-api-boilerplate
✨ Create APIs with NodeJS + Express easily.
https://github.com/helderberto/node-api-boilerplate
express node-api node-boilerplate node-starter nodejs
Last synced: 10 months ago
JSON representation
✨ Create APIs with NodeJS + Express easily.
- Host: GitHub
- URL: https://github.com/helderberto/node-api-boilerplate
- Owner: helderberto
- License: mit
- Created: 2020-04-11T14:11:11.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-12T11:03:00.000Z (about 3 years ago)
- Last Synced: 2025-01-24T10:28:10.733Z (12 months ago)
- Topics: express, node-api, node-boilerplate, node-starter, nodejs
- Language: JavaScript
- Homepage:
- Size: 744 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Node API Boilerplate
[![License][license-badge]][license-url] [![Commitizen][commitizen-badge]][commitizen-url]
✨ A simple and quick way to start your API using NodeJS + Express.
## Requirements
- [NodeJS](https://nodejs.org/en/);
- [Yarn](https://yarnpkg.com/);
## Getting Started
The most quickly way to start your project is following the example:
```bash
# Get the latest snapshot
$ git clone git@github.com:helderburato/node-api-boilerplate.git ~/
# Change directory
$ cd
# 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](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](https://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/helderburato/node-mvc-boilerpalte/tags).
## Authors
- **Helder Burato Berto** - _Initial work_ - [helderburato](https://github.com/helderburato)
See also the list of [contributors](https://github.com/helderburato/node-api-boilerplate/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
[license-badge]: https://img.shields.io/github/license/helderburato/node-api-boilerplate.svg
[license-url]: https://opensource.org/licenses/MIT
[commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
[commitizen-url]: http://commitizen.github.io/cz-cli/