Este proyecto es un servidor básico que proporciona ejemplos para comprender los conceptos básicos de RESTful API.
- Definir los alcances de nuestro RESTServer
- CRUD
- Encriptación de contraseñas
- Validaciones personalizadas
- Creación de roles
- Conexiones con MLAB
- Despliegue de base de datos en la nube
- Conexión con Robo 3T con base de datos en la nube
- Configuración de variables de entorno
- Borrado de archivos
- Eliminado físico de la base de datos
- Eliminación por estado en un campo de la colección
Asegúrate de tener Node.js y npm instalados en tu máquina antes de comenzar.
-
Clona el repositorio:
git clone https://github.com/Joguisa/restserver.git cd restserver
-
Instala las dependencias:
npm install
-
Crea un archivo
.env
en la raíz del proyecto y configura las variables de entorno según sea necesario. Puedes seguir el formato del archivo.env.example
proporcionado.
-
Para ejecutar el servidor en modo de desarrollo con nodemon:
npm run dev
/src
: Contiene el código fuente de la aplicación./routes
: Define las rutas de la API./controllers
: Contiene los controladores que manejan la lógica de las rutas./public
: Carpeta para archivos estáticos (si es necesario)./database
: Contiene la lógica de conexión a la base de datos MongoDB./helper
: Contiene funciones auxiliares para validaciones y lógica de roles./middlewares
: Contiene middleware para validar campos en las solicitudes./models
: Define los modelos de datos para la base de datos.
- Express: Framework web para Node.js.
- Cors: Middleware para habilitar CORS en Express.
- Dotenv: Carga variables de entorno desde un archivo .env.
- BcryptJS: Librería para el hash de contraseñas.
- Express Validator: Middleware para validación de datos en Express.
- Mongoose: ODM (Object Document Mapper) para MongoDB.
Este proyecto está bajo la Licencia ISC.