Daiane567 / rest-boilerplate

This repository is a simple and small boilerplate for a Rest API with Node.js.

Rest API Boilerplate for Node.js (Simple & Small) 🤖

This repository is a boilerplate for a Rest API with Node.js. There are some other boilerplates available, but they are too big. This boilerplate is small and only the most necessary inside.

_{Suggestions for improvement, problems and feedback you can always tell me on Twitter or here.}

Features ⚡

• Dynamic creation of routes
• Preinstalled nodemon for faster development
• REST Client for testing routes
• 404 Route Handling
• Simple MySQL Database file
• Enviroment Variables (.env) for security (API keys, password,...)
• Colored error and log messages

Usage 📑

1. clone the repository with git clone https://github.com/lorenzhohmann/rest-boilerplate.git
2. navigate in the directory and execute npm install
3. Rename _.gitignore to .gitignore (Optional: When you're using Visual Studio Code, you can install REST Client for testing your routes.)
4. Start coding!

Planed 📅

• Better documentation
• CORS Handling
• MongoDB (mongoose) class sample

Changelog

• 1.0.1
  • Improved documentation
  • Fixed bug when getting dynamic routes
• 1.0
  • Initial commit

License

You are allowed to do everything with this code you want. It would be nice if this repository is mentioned, but it is not mandatory.