Giter VIP home page Giter VIP logo

siwback's Introduction

Prueba Técnica - Siw Cargo

Demo

Puedes ver una versión actual del proyecto aquí

Cómo instalar y correr el proyecto localmente

Detalles importantes a tener en cuenta:

1. Clonar el proyecto

$ git clone https://github.com/txakurhub/siwback

2. Instalar dependencias (en el directorio raíz)

$ npm install

3. Configurar las variables de entorno

Deberá crear o tener creada una base de datos, a la cual le deberá cargar los siguientes datos para la correcta conexión con la misma.

$ DB_USER
$ DB_HOST
$ DB_PASSWORD
$ DB_NAME
$ DB_PORT

A su vez, deberá crear una nueva variable para la clave para el JWT Secret con el nombre

$ SECRET

4. Levantar el proyecto

$ npm run dev

Felicitaciones, el proyecto está corriendo localmente.


Ficha Técnica

Esta ficha técnica describe los diferentes comportamientos y funcionalidades del proyecto realizado para Siw Cargo. Proporciona una guía detallada sobre las acciones que los usuarios pueden realizar y cómo el sistema debe responder a esas acciones.

1. Descripción general

El proyecto consta de una aplicación web que permite a los usuarios, registrarse, logearse, editar sus datos, ver y explorar sobre una colección de facturas. Los usuarios pueden ver información detallada de cada factura, incluyendo su id, el id del cliente, la fecha, y el monto total.

2. Endopoints

Auth:

  • POST /auth/login -> Login del usuario en la API, espera:
  {"email":"[email protected]", "password":"contraseña"}

  • POST /auth/signup -> Sign up del usuario en la API, espera:
 { "username": "nombredeusuario","email": "[email protected]", "password": "password"}
  • POST /auth/getuser -> Devuelve la información del usuario en la API, espera:
 {"email":"[email protected]"}
  • PUT /auth/update -> Modifica la información del usuario en la API, espera:
 {"email":"[email protected]", "newUsername":"nuevonombre", "newEmail":"[email protected]" }
  • PUT /auth/recovery -> Modifica la contraseña del usuario en la API, espera:
 {"email":"[email protected]"}

Tickets:

  • GET /tickets -> Obtiene todas las facturas en la base de datos
  • POST /tickets -> Crea una nueva factura en la API, espera:
 {"cliente":"id", "total":"123" }

siwback's People

Contributors

txakurhub avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.