To run the API, you will need Node.js version 17+ installed on your machine. Download it here:
First, clone the repository :
git clone https://github.com/leiberbertel/API-Restful-node-mvc.git
cd API-Restful-node-mvc
Next, open your command terminal and located in the project root, execute the commands:
npm install
# Environment MySQL
npm run start:mysql
# Environment MongoDB
npm run start:mongodb
# Environment Local
npm run start:local
The application will launch and be running on port 1234
All endpoints and schemas are documented using Swagger UI. You can view the documentation at http://localhost:1234/docs/, which is the default endpoint for the Swagger UI.
- Node version 20.9 - Language used
- MySQL - Database Engine
- MongoDB - Database Engine
- Express - Framework used
- Zod - Model Validation Unit
- Dotenv - Dependency for environment variables
- Semistandard - Dependency to format the code