ryan-storey/travel-buddy

A travel companion to help plan your journey while saving both money and the planet by providing route analysis and a carpool marketplace.

Travel Buddy

A travel companion to help plan your journey while saving both money and the planet by providing route analysis and a carpool marketplace.

Installation

Python Version

The application has been developed and tested to work on Python 3.8 and onwards.

Running the Application Locally

To run the application, you should follow the following steps:

1. Clone this GitHub repository.
2. Ensure that you're in the root directory: travel-buddy
3. Install the required Python libraries: pip install -r requirements.txt
4. Install the code as a package on your local machine with the command: pip install -e .
5. Run the application with the command: python -m travel_buddy.app
6. Navigate to http://127.0.0.1:5000/ in your web browser.

Running Tests Locally

1. Clone this GitHub repository.
2. Ensure that you're in the root directory: travel-buddy
3. Install the required Python libraries: pip install -r requirements.txt
4. Install the code as a package on your local machine with the command: pip install -e .
5. Run all tests with the command python -m pytest
6. View test results in the terminal.

Demo Instructions

A demo database has been set up by default (db.sqlite3), with some sample user accounts to save the hassle of registration and make it easy to get started:

• Username: johndoe | Password: P@ssword01
• Username: janedoe | Password: P@ssword01