VIADE EN1B

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

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

Check it out!

Remember to add https://arquisoft.github.io to your trusted apps in SOLID (Read, Append, Write and Control).

In case you experiment any error related to ACLs, it is SOLID stuff, please create a new POD to test all the functionalities of our application.

Contributors

• Marcos Álvarez García — alvarezGarciaMarcos
• Pelayo García Álvarez — garciaAlvarezPelayo
• Álvaro García Infante — alvaro_garinf
• Íñigo Gutiérrez Gernández — InigoGutierrez
• Eduardo Lamas Suárez — lamasumas
• César García Cabeza — themrcesi

Documentation

The documentation is available here.

Development

This project was generated using Create React App.

Getting started

In order to run this project, you will need to follow these steps:

1. Install Ruby

We recommend to install ruby using RubyInstaller

2. Install Node & NPM

3. Install asciidoctor

   1. Then, install asciidoctor-diagram:

      gem install asciidoctor-diagram

      In windows issue this command using the terminal provided by RubyInstaller. In linux sudo may be needed, depending on the installation.

4. Run

npm install

to have all the dependencies needed.

Generating the documentation

Execute

npm run docs

to generate the html documents and dependencies (all the documents will be stored in /build/docs).

Development server

If you want to test the application in your local machine, you will need run a development server in your machine.

1. Run npm start.
2. Go to your browser and navigate to http://localhost:3000/viade_en1b.

Remember to add http://localhost:3000 to your trusted apps in SOLID (Read, Write, Append, Control).

Building the application

If you want to build the application you need to run npm run build and all the files will be stored in /build.

Running unit tests

If you have any development server running, close it please, because tests need the port 3000 in order to run.

To execute the unit tests, you need to run npm test.

This tests have been created using Jest.

Running end-to-end tests

First of all run npm start and then run npm run cucumber.

This tests have been created using Cucumber and Selenium.

Running load tests

First of all you need to run the development server with npm start.

Windows

In Windows, you must run the following commands:

1. mkdir .\reports\load-testing (only the first time)
2. npx artillery run ./load-testing/dashboard.yml -o .\reports\load-testing\reportName.json
3. npx artillery report ./reports/load-testing/report.json -o .\reports\load-testing\reportName.html

The report will be in /reports/load-testing. Enjoy it!

Linux

In Linux, it is as simple as doing:

npm run artillery-linux

Then the report will be in /reports/load-testing. Enjoy it!

This tests have been created using Artillery.

Docker

In order to use our Dockerized application, you must to have Docker installed on your computer. Once that's done, you have to follow these steps:

• Open a command prompt.

• Set yourself on the root directory of our cloned repo

• Type the following command:

  • docker build -t viadeapp
  • This will build the Docker image for you, that can be run later on a container.
  • docker run -p 80:3000 viadeapp
  • This will launch a container with the viadeapp image, and will expose map your localhost port 80, to the container port 3000.

• Now, the only thing you have to do is to go to your favourite web browser, and browse to: http://localhost and you will be served with the Viade app!

Further help

To get more help on the React use npm help or go to their main webpage.

Application

Accessibility

We are concerned about every kind of users, specially color blind people.

Regarding this fact, we have included a functionality to change in runtime the theme of our application in order to solve the three main color blindnesses:

1. Protanopia: confusion of reds and greens and loss of sensitivity to red light.
2. Tritanopia: confusion of blues and greens an which sensitivity to blue is reduced.
3. Deuteranopia: confusion of blues and greens, of greens and reds and which sensitivity of green is reduced.

In Chrome you can check it using this plugin.

Internationalization

Currently, our application is internationalized for English and Spanish.

This have been done using React Intl.

Basic use

If you want to know about how to use our application, you can go to our user manual.