README.md

dede_es2c

This project is a basic example of website using React with Typescript and an endpoint using NodeJS with express.

Quick start guide

In case you already have node.js and npm, make sure you update them before attempting to build the images

If you want to execute the project you will need git, Node.js and npm and Docker. Make sure the three of them are installed in your system. Download the project with git clone https://github.com/arquisoft/dede_0. The fastest way to launch everything is with docker:

docker-compose up --build

This will create two docker images as they don't exist in your system (the webapp and the restapi) and launch a mongo container database. It will also launch Prometheus and Grafana containers to monitor the webservice. You should be able to access everything from here:

• Webapp - http://localhost:3000
• RestApi example call - http://localhost:5000/api/users/list
• RestApi raw metrics - http://localhost:5000/metrics
• Prometheus server - http://localhost:9090
• Grafana server http://localhost:9091

If you want to run it without docker. Compile and run the restapi:

cd restapi
npm install
npm start

Now the webapp:

cd webapp
npm install
npm start

You should be able to access the application in http://localhost:3000.

More information

You can get more information about the respository in the other README files:

• Documentation: https://github.com/Arquisoft/dede_es2c/tree/master/docs
• Webapp: https://github.com/Arquisoft/dede_es2c/tree/master/webapp
• Restapi: https://github.com/Arquisoft/dede_es2c/tree/master/restapi

Two videos have been made explaining how the application works, the links to these are:

• Administrator's vision
• Client's vision

Team members

• Ruben Rubio Del Castillo - UO276255
• Darío Martínez Bajo - UO278290
• Efrén García Valencia - UO277189
• Adrián Santamarina Romero - UO279062
• Ana Fernández Ostio - UO275780