search

Arquisoft / viade_es2c

Viade es2c is a decentralized routes management system based on the solid specifications and React framework created by some students at "Universidad de Oviedo".
https://arquisoft.github.io/viade_es2c/
GNU General Public License v3.0
0 stars 4 forks source link

readme

VIADE ES2C

Build Status codecov Codacy Badge Version Badge Website cv.lbesson.qc.to PRs Welcome Awesome Badges

DESCRIPTION

Viade is a decentralized routes management system based on the solid specifications and React framework. It is a project from the Software Architecture course taught in "Universidad de Oviedo" and its purpose is to teach the students how to work in a real project and how to create a good project architecture. We also are learning how good documentation is made and how to interact with the rest os the programmers of the world using forums or chats.

About us

We are the students who form the "ES2C" group of creating the Viade app, here you can find some information about us:

Feel free to contact us whenever you want!

Content

This repository contains our progress developing Viade, that includes code and documentation.

Interesting links

This project is an assignment for the Software Architecture course following these requirements.

The app is deployed at https://arquisoft.github.io/viade_es2c/ which also contains a technical documentation.

More information about how this project has been setup is available in the wiki.

Use Viade

To use viade you have various options:

Clone the repository

You can create a folder and clone this repository on it executing.

Then, you will need to execute 

npm install

Remember to download NodeJS before. You need to do that so the libraries and dependencies that Viade uses can be downloaded into your computer.

Last, you just need to execute 

npm run start

And viade will be deployed in http:localhost:3000.

Use Docker

As you can see, we have a Dockerfile and a docker-compose.yml file in our repositoy. You can use them to create a docker image of viade an execute it into a docker container.

To do that, you just need to clone this repository and execute the following command into the folder that was created:

sudo docker-compose -f docker-compose.yml up

Container will be deployed at http://localhost/viade_es2c

Use the gh-pages version

The easiest way to try Viade is to go to this link https://arquisoft.github.io/viade_es2c/. It shows the master branch version of Viade and you wont need to download anything