Skip to content

Latest commit

 

History

History
72 lines (44 loc) · 1.95 KB

SETUP.md

File metadata and controls

72 lines (44 loc) · 1.95 KB

Setup

Step 1: Install the GitHub desktop app

Step 2: Press the green "Clone or download" button at the top of this page and then "Open in Desktop" to open the repository inside the app. Then you can clone (download) the repository to your computer.

Step 3: After you clone the repository, open up the Terminal (Mac) or Command Prompt (Windows) and go to where you copied the project

On Mac

cd ~/Documents/GitHub/PointerServer

On Windows

cd Documents\GitHub\PointerServer

cd is change directory

If you want a very basic overview of the Terminal, you can check this

Step 4: Install virtualenv

On Mac

sudo pip install virtualenv

On Windows

pip install virtualenv

If you get an error about not having pip, you can install it following the instructions here

If you get an error about not having python while installing pip, you can install it following the instructions here.

If you still get an error about not having python or pip, you might have to add C:\Python27 and C:\Python27\Scripts to your environment variables following the instructions here.

Step 5: Create the virtual environment

virtualenv venv

The virtual environment is used so that different Python projects can use different libaries without problems.

Step 6: Install Flask

On Mac

. venv/bin/activate
pip install -r requirements.txt

On Windows

venv\Scripts\activate
pip install -r requirements.txt

Step 7: Celebrate 🎉

Try running the project by following the README!