Viade - Decentralized Routes

Currenty this project is WIP.

Documentation

Technical documentation is available on Docs.

Deployment

Application is automatically deployment using Github delivering deployment.

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

Getting Started

Requirements

NodeJS >= v.12.4

Installing

npm install

In this moment, you can check if installation has been completed succesfully running tests.

Running

npm start

Running with Docker

Using Docker image

This will enable you to try ViaDe App on http://localhost/viade_es5a.

docker run -it --rm jaluma/viade_es5a

Using Docker-Compose

Additional, we can launch it with SolidServer on https://localhost:8443.

docker-compose -f docker-compose.yml up

Running the tests

Currently, we are testing with a framework called Jest.

Our tests are executed automatically in Travis CI. Additionally, we use codecov as a tool to see what part of the code the tests are covering.

If you would like to run tests locally, run the following after installing dependencies:

npm run test

Building documentation

If you would like to build docuemntation locally, run the following:

Note: it is necessary to have installed and configured Ruby in the environment variables. More info in Ruby Official Page.

npm install
gem install asciidoctor
gem install asciidoctor-diagram 
npm run docs

Wiki

Weekly meetings are uploaded to Wiki.

Deployment

Application is automatically deployment using Github delivering deployment.

Built With

• React - The web framework used
• Social Linked Data - The persistance layer used
• ldflex - Library used to query the persistance
• Google Maps API - Library used for all relative maps
• Jest - Testing framework used

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Javier Martínez Álvarez - jaluma
• María Isabel Fernández Pérez - isafdezpe
• Luis Carlos Hurlé Fleitas - luishurle94
• Adrián Vaz Sánchez - Adri-San

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

Skelenton built using Solid React Application Generator.

Task list

• Documentation based on Arc42.
  • Initial version.
  • Final version.
• Skeleton.
• Service Layer.
• Solid Adapter.
• Map.
  • Generate internal GeoJson from Route.
  • Export GeoJson/KML/GPX.
  • Secure Google Maps API Key.
• Management
  • Create Route.
  • Create Milestones.
  • List my routes.
  • Details.
  • Share route.
    • Share routes.
    • List shared routes.
  • Friends
    • List friends.
    • Add friends.