Virgil's Travels

CECS 445 - Traveler's Guide Web App

Created by Bryan Rojas, Hector Mendoza, Clay Asada, David Ibarra, Brandon Mitchell

Prerequisites

Specifications & Tools

• 64-bit environment (Trying to make it system agnostic)
• Git

Back-end

• Python 3.7.x
• Pip

Front-end

• Node.js

Downloading Application

1. Ensure git is installed on computer. You can verify by running the following command on your terminal.

git --version

2. Clone the GitHub repository.

git clone https://github.com/Project-Abeona/Virgils-Travels.git

Verify Prerequisites

1. Verify you have Python 3.7.x, open up terminal and run the following command.

python -V

2. Verify Node.js is installed.

npm -version

Running Application

Open two different terminals, one for the back-end and the other for the front-end. Make sure both applications are running simultaneously.

Back-end

1. Change directory (cd) into the project folder.

cd Virgils-Travels

2. Change directory (cd) into the back-end folder.

cd back-end

3. Install Python dependencies.

py -m pip install -r requirements.txt

4. Running the API server.

python manage.py

Front-end

1. Change directory (cd) into the project folder.

cd Virgils-Travels

2. Change directory (cd) into the back-end folder.

cd front-end

3. Install Node.js dependencies.

npm install

4. Running front-end client.

npm run start

Contributing

0. Ensure the repository is cloned and you can change directory (cd) where it is located.

git clone https://github.com/Project-Abeona/Virgils-Travels.git
cd Virgils-Travels

1. Pull the latest version from GitHub

git pull

2. Create a branch for your changes. The name of the branch should be relevant to the work/changes being done.

git checkout -b "Bug-Fix"

3. Add changes to your branch via git add command. "." character can be replace with a specific file if you don't want to add all changed files.

git add .

4. Commit changes with a relevant message.

git commit -m "Bug-Fix: Fixed issue with login."

5. Push changes to GitHub

git push origin HEAD

6. Create Pull Request

7. Send pull request to CECS 445 Discord Chat

8. Wait for code review and someone else to approve your changes.

9. Merge changes to master branch.