SE750-Group14-GirlGang / roadtrip-planner

An application to help you and your friends plan a roadtrip!
Apache License 2.0
3 stars 2 forks source link

Welcome to Roadie!

Roadie is an application designed to help with all aspects of roadtrip planning

Click here to view our wiki! It has tons of information about our Github workflow, application features, frontend and backend structure, design, and our project management.

This README is just for how run the application and how to run tests.

To Run the Application

The application frontend and backend must be running at the same time. Follow the general installation instructions, then follow the separate instructions to get the frontend and backend runnning.

General Instructions

Run the Frontend

REACT_APP_AUTH0_DOMAIN=XXXXX
REACT_APP_AUTH0_CLIENT_ID=XXXXX
REACT_APP_AUTH0_AUDIENCE=XXXXX
REACT_APP_MAPBOX_TOKEN=XXXXX
REACT_APP_SPOTIFY_CLIENT_ID=XXXXX
REACT_APP_SPOTIFY_CLIENT_SECRET=XXXXX
REACT_APP_SPOTIFY_REDIRECT_URI=XXXXX

Run the Backend

MONGO_DB_PW=XXXXX
MONGO_DB_USERNAME=XXXXX
REACT_APP_AUTH0_AUDIENCE=XXXXX

Open the Application

To Test the Application

Test the Frontend Using Cypress

Cypress is used for frontend integration testing. The frontend must be running for these tests to work. The backend does not need to be running.

Test the Frontend Using Jest

Jest is used for frontend unit testing.

Test the Backend

Jest, Express, MongoMemoryServer, and Babel Rewire are used for backend integration and unit testing. Backend dependencies must be installed. The backend and frontend must not be running for these tests to work (port usage will conflict)