Project 3

Final Project for CSCI 204!

Getting Started

Just git clone the project, set up the virtual environment and run!

Setting up Git

It might be lengthy at first but you'll get used to it over time

First time setting up Git

Tell Git who you are

git config --global user.email "you@example.com"
git config --global user.name "Your Name"

Generate SSH key (To make connection with Git)

ssh-keygen -t rsa

then see the SSH key

cat ~/.ssh/id_rsa.pub

Copy the key (including the "ssh-rsa" at the beginning)

Click on your avatar, click on Settings near the end, click on SSH and GPG keys tab, click New SSH key, paste the key and click Add SSH key

Clone Project from Github

git clone git@github.com:sontungtran/CS204-Project3.git

Navigate into the file

cd CS204-Project3

Create new branch & navigate into your branch

git checkout -b your-virtual-environment-name

and check with git status

Make sure you run git pull before editing anything

After your work is done

Push to your branch with

git add -A
git commit -m 'Commit Message'
git push origin [your branch's name]

Setup Virtual Environment

Create your own virtual environment

python3 -m venv ~/your-virtual-environment-name

Activate virtual environment with

source ~/your-virtual-environment-name/bin/activate

and install packages

python3 -m pip install -r requirements.txt --user

Bridges

Documentation

Example

Running the tests (TODO)

Authors

Tung Tran

Arsh Noor Armin

Amanda Christy

Sam Citron

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgements

• Thanks Prof. Dancy for giving us 1 week to setup all these
• Inspiration: Not to get C for the Final Project
• Look at dis GIF!