Api construida en node y Express. Mas allá de un sistema CRUD se ofrece una aplicación con integración a diferentes bases de datos relacionales y no relacionales como Maria db, Sqlite, Mongo y Firebase. Un chat contruido con Socket IO y un sistema de autenticación y de registro junto con el renderizado de dos vistas una en modo administrador y otra en modo usuario.
- Node.js - Evented I/O for the backend
- Express - Framework to develop the backend
- Express-handlebars - Engine to develop the UI
- Normalizr - Tool to normalize some data in DB
- Multer - Middleware to upload images in server
- MongoDb - Optional noSQL database
- Mysql2 - Optional SQL database
- Sqlite3 - Optional SQL database for chat
- firebase-admin - Optional noSQL database
- Knex - Query builder to interact with MariaDb
- Mongoose - ODM to interact with mongoDB
- Passport - Authentication middleware
- Passport-Local - Strategy used of passport to aunthenticate users
- Express-Session - Middleware to create sessions of users who has been autheticated
- Connect-Mongo - Module of mongo db t work with session.
- Socket-io - Library to work with sockets
- Nodemailer - module for Node.js applications to allow easy as cake email sending.
- Bcrypt - A library to help you hash passwords.
- Twilio - The Twilio REST API allows you to query and manage meta-data about your account, phone numbers, usage, and access tokens.
- Winston - Winston is designed to be a simple and universal logging library with support for multiple transports.
- Yargs - Yargs helps you build interactive command line tools, by parsing arguments and generating an elegant user interface.
- Mocha - Mocha is a feature-rich JavaScript test framework running on Node.js and in the browser, making asynchronous testing simple and fun.
- Chai - Chai is a BDD / TDD assertion library for node and the browser that can be delightfully paired with any javascript testing framework.
- Supertest - The motivation with this module is to provide a high-level abstraction for testing HTTP, while still allowing you to drop down to the lower-level API provided by superagent.
http://localhost:8080/Esta es la ruta inicial de la aplicación desde donde se podra realizar un proceso de login mediante un username y un password. En el caso de no contar con una cuenta dirijase a la ruta Register.
| Method | Route | Reason |
|---|---|---|
| Get | / | Renderizar la UI determinada para el login |
Esta ruta provee al usuario de una UI para el registro junto con el endpoint definido para regsitrar sus datos en DB, encriptar su contraseña y redirigir al login para ingresar a la aplicación.
| Method | Route | Reason |
|---|---|---|
| Get | api/v1/register | Renderizar la UI determinada para el sign up |
| Post | api/v1/register | Registrar el usuario en mongoDB |
| Method | Route | Reason | |
|---|---|---|---|
| Post | api/v1/profile/ | Redirigir al usuario con su username en la URL al proceso de autorizacion | |
| Get | api/v1/profile/admin | Renderizar la UI del admin logueado | |
| Get | api/v1/profile/user/:username | Renderizar la UI del usuario logueado | |
| Post | api/v1/profile/logout | Realizar el logout del usuario y redirir al login |
En las siguientes rutas se proveeran los endpoints en donde se administraran los diferentes productos en la base datos
| Method | Route | Reason |
|---|---|---|
| Get | api/v1/productos/:id? | Obtener productos por id o todos si no se provee el id |
| Get | api/v1/categorias/:category | Obtener productos por categoria |
| Post | api/v1/productos/ | Agregar productos a la base de datos |
| Put | api/v1/productos/:id | Actualizar productos por id |
| Delete | api/v1/productos/:id | Borrar productos por id |
En las siguientes rutas se proveeran los endpoints para crear carritos de compras en donde se almacenaran los productos a comprar por el cliente desde la UI
Nota: Estas rutas tienen un acceso público por lo tanto no es necesario proveer credenciales.
| Method | Route | Reason |
|---|---|---|
| Post | api/v1/carrito/ | Crear carrito |
| Delete | api/v1/carrito/:id | Borrar Carrito |
| Get | api/v1/carrito/:id/productos | Listar los productos del carrito |
| Post | api/v1/carrito/:id/productos | agregar productos al carrito |
| Delete | api/v1/carrito/:id/productos/:id_prod | Borrar productos del carrito |
En la siguiente ruta podras acceder a una tabla de productos con una imágen aleatoria con el fín de proveer de data falsa a la UI que la necesite. Por defecto provee 5 productos pero si el usuario necesita de más o menos cantidad puede hacerla explicita al final de la ruta
| Method | Route | Reason |
|---|---|---|
| Get | /api/v1/test/helloworld | print "hello world" |
| Get | /productos-test/:quantity? | Generar lista d eproductos falsos por fakerJS |
| Get | /tech-info | Mostrar aspectos técnicos del coomputador del usuario por medio de NODE |
| Get | /randoms | Realizar un procedimiento demandante para poner en uso procesos fork en NODE |
| Get | /randoms-ngnix | Controlador para realizar pruebas sencillas con ngnix |
Esta ruta se implemento con el fin de agrupar los diferentes procedimientos de notificación tanto al usuario como al administrador cuando una compra sea realizado haciendo uso de Twilio y Nodemailer
| Method | Route | Reason |
|---|---|---|
| Post | /api/v1/order | Ruta de inicio para ejecutar procedimientos de finalizacion de compra |
To run the app in dev mode:
pnpm i
pnpm run devTo run test with mocha:
pnpm run testusername: admin
password: 12
in this mode you will have the option to add, delete and update products.
in case that you want
buy something you will have to login as a user but first you will have to register in login UI
filling the form with your data, then you will going to be redirect to the user interface and there
you will have the options to buy a product added as an admin
You can find other starter scripts modes in the package.json file