scaffolding for project configuration of a rest api
These instructions will allow you to obtain a copy of the project in operation on your local machine for development and testing purposes..
See Deployment to know how to deploy the project.
You must have installed node.js and mongodb
1-you must clone the repository on your machine and then locate yourself inside the project file
2-install modules
npm install
for production_
npm run start ó npm start
for development
npm run dev
Folder node_modules => will contain imported modules developed by third parties, if you have created a module please save it in the middlewares folder
do not place any modules created by you in this folder
Folder middlewares => will contain the modules generated by the developers, must clarify their good use, considering that a middleware its injection goes in the header of the request of the end point
does not carry a naming rule
Folder models => will contain database schemas, you must follow this rule
Schema<Nombre>.js
Folder services => contain the services that will be injected into the logic of the controller files
does not carry a naming rule
Folder controllers => goes the logic of response, manipulation and use that are received from the end point
Ctrl<Nombre>.js
configuration.js => go the server port configurations, database, and required configurations
server.js => run file of the project both production and development
app.js => installation and use of modules
carpeta routes => goes the routes of the end points and their configuration
does not carry a rule of nomenclarura
if there is no error in console go to the path
http://localhost:8888/api/v1
if you are a developer and will contribute to the development consider the reply message
- express -
- Ricardo Perez
This project is under License (RP)
⌨️ con ❤️ por Ricardo Perez