Git Product home page Git Product logo

hydra's Introduction

Hydra

Servicio de backend para el proyecto:
"Diagnostico de la situacion actual de la industria del software en la ciudad de San Francisco de Campeche.

Notas

Esta aplicacion es una API construida con NodeJS + Express + MongoDB Es totalmente independiente del proyecto "Phoenix" por lo que se puede construir una aplicacion sobre esta API.

Para cada endpoint su request body puede ser encontrado leyendo el codigo de dichos endpoints (organizados lo mejor que se pudo en carpetas.)

Es de alta importancia llenar el archivo .env (copiado de .env.example) y colocar sus llaves (diferentes) para encriptacion de diversos elementos, asi como definicion de la base de datos a la que se conectara y el puerto donde empezara a escuchar peticiones.

Para probar los endpoints se puede activar el DEV_MODE del archivo .env para saltar validaciones de tokens y poder hacer postmans de manera libre, con validacion activa ningun request a algun endpoint administrativo deberia pasar.

Autenticacion

La autenticacion funciona por JWT Tokens que se reciben en el header bajo la llave auth-token, estos tokens tienen una duracion de 2 dias por defecto.

Endpoints

  • Publicos

    • */api/preguntas
    • */api/estadisticas
    • */api/estadistica_empresas
  • Cuenta

    • */auth/login
  • Administrador

    • */admin/entidad
    • */admin/status
    • */admin/resultados
    • */admin/usuario <- Este endpoint esta activo, mas no se usa.

Roles

  • 0: Alumno
  • 1: IES
  • 2: Empresa
  • 3: Admin (Requiere Creacion Manual)

Instalacion

  • Clonar el repositorio
  • Iniciar quitar el ".example" del ".env" y configurarlo con los datos propios.
  • Ejecutar "npm i" o "npm install" en la terminal en la raiz del proyecto
  • Para correr el proyecto se ejecuta "nodemon app.js" en la raiz del proyecto (development branch).

Deploy en Docker

  • Tener docker instalado
  • Ejecutar docker build -t "hydra" . en la raiz del proyecto. (donde esta el Dockerfile)
  • Iniciar desde docker.

hydra's People

Contributors

ezpadaz avatar angelmt2396 avatar

Watchers

 avatar

Forkers

angelmt2396

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.