https://github.com/leiberbertel/api-restful-node-mvc

This is a Restful API programmed in node.js, express with an MVC architecture, cors configuration, model validation with Zod and dotenv environment variables, it has models pointing to MySQL instances, MongoDB and the local system.
https://github.com/leiberbertel/api-restful-node-mvc

cors dotenv express mvc-architecture nodejs zod

Last synced: 10 months ago
JSON representation

This is a Restful API programmed in node.js, express with an MVC architecture, cors configuration, model validation with Zod and dotenv environment variables, it has models pointing to MySQL instances, MongoDB and the local system.

• Host: GitHub
• URL: https://github.com/leiberbertel/api-restful-node-mvc
• Owner: leiberbertel
• License: mit
• Created: 2023-12-10T04:12:53.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-12T00:13:52.000Z (about 1 year ago)
• Last Synced: 2025-01-11T07:38:01.485Z (12 months ago)
• Topics: cors, dotenv, express, mvc-architecture, nodejs, zod
• Language: JavaScript
• Homepage:
• Size: 58.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Movie API Restful 

### _This is an API for the basic operation of a movie app with MVC architecture_:

![Static Badge](https://img.shields.io/badge/version-1.0-brightgreen)

![Static Badge](https://img.shields.io/badge/Node-20-brightgreen)

## Running the API 🚀

To run the API, you will need Node.js version 17+ installed on your machine.

[Download it here:](https://nodejs.org/en)

First, clone the repository :

```bash

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:

```bash

npm install 

```

```bash 

# 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.

## Built with 🛠

 * 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