guacamole-fe

An online travel community to share luggage spaces onboard. (frontend)

Description

This is a travel tour luggage space sharing app for assisting different tourists ravelling across the globe to collaborate on sharing their luggage spaces.

Application Heroku Links

• Backend (Swagger Documentation): swagger-documentation

• Frontend (Kari4me App Hosting): mobilities react web app

• Postman collection

Development set up

1. Install Node JS.
2. To clone, run git clone https://github.com/andela/activo-web.git.
3. cd into the root of the project directory.
4. Install yarn.
5. Run yarn install on the terminal to install dependencies.
6. Create a .env file in the root directory of the application. Example of the content of a .env file is shown in the .env.example
7. Setup local development server.

• In your terminal, execute the following command:

    sudo nano /etc/hosts
  

  Otherwise, you can open your hosts file in your editor of choice.

• Add the following line to your hosts file:

    127.0.0.1 kari4me.com
  

• Save changes and quit the editor.

8. To start the application run yarn start:dev

Testing

End To End tests - Run test:e2e on the terminal while within the project root directory. End to End testing is achieved through use of http-server and Cypress packages. http-server is used to create a simple web server and Cypress is used for the browser automation. They will both be installed when you run yarn install

Unit tests - Run test:unit on the terminal while within the project root directory. Unit testing is achieved through the use of jest package. jest is used to test javascript code in React applications.

API Documentation

Find the link to the API documentation here.