DontStopPrograming / DontStopPrograming/Backend_standard

Create: Implementation of a CRUD REST API with Express.js and MongoDB

Abierto
#3 0 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
TypeScript
Estrellas
0
Forks
0
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Implement a REST API that allows performing CRUD (Create, Read, Update, Delete) operations on a specific resource using Express.js, MongoDB, and Mongoose. The implementation should follow principles of separation if concerns, Clean Architecture, and best practices in managing routes, controllers, services, and models.

Task to complete:

1.Develop the project structure:

- Set up a Node.js project with TypeScript
- Organize the folder and file structure to reflect the separation of concerns

2.Configure MongoDB connection:

- Create a configuration file for connecting to MongoDB using Mongoose.
- Ensure the connection correctly uses the database specified in the .env file

3.Define the resource model and interface:

- Create the resource interface(e.g. Vehicle) that reflects the required properties.
- Implemente the Mongoose Schema and Model based on the interface

4.Implement CRUD services:

- Develop service functions to handle CRUD operations for the resource
- Ensure that service functions are decoupled from the controllers

5.Create controllers and routes:

- Implement controllers that manage HTTP request for CRUD operations
- Define and set up the corresponding REST routes in Express.js

6.Add validations and error handling:

- Implement data validations in the controllers or models
- Create an error-handling middleware to capture and manage exceptions in the API

7.Document the API:

- Provice clear and concise documentation

8.Perform functional testing:

- Use tools like Postman, ThunderClient to test and validate CRUD operations
- Ensure that data is correctly stored, update and deleted in MongoDB

Criteria:

- The API should allow performing all CRUD operations on the defined resource.
- The database connection should be stable and use the database specified in the .env file
- The project structure should follow Clean Architecture principles and coding best practices

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Línea de trabajo

Start by inspecting the repository structure and existing project configuration before planning the implementation. The issue identifies the needed layers—configuration, models, services, controllers, routes, validation, and error handling—and names .env, Postman, and ThunderClient as relevant entry points. Done means CRUD operations work for the chosen resource, MongoDB uses the .env database, and the API is documented and functionally tested.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
express, mongodb, nodejs, typescript
Área
api, backend, database
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.