Reptile Installation Guide
Quick Summary
- Clone the repo: Reptile GitHub page
- Install required packages:
pip install -r requirements.txt
- Set flask environment variables:
- Windows:
set FLASK_APP=app.py
,set FLASK_ENV=development
- Mac/Linux:
export FLASK_APP=app.py
,export FLASK_ENV=development
- Windows:
- Start the site:
flask run
orpython3 app.py
What You Need
- A computer with MacOS (for PC users, use Ubuntu in a VM)
- Basic familiarity with the Terminal app
Step 1: Software Requirement Specifications - Install Python
- Make sure you have Python installed by typing
python --version
into Terminal. If you don’t, download it from Python’s website.
Step 2: Download Reptile from GitHub
-
Visit the Reptile GitHub page
-
Use the green “Code” button to find the SSH option and copy the link provided, i.e.,
git@github.com:Columbia-DESDR/Reptile.git
-
In Terminal, navigate to where you want the project. For example:
Terminal window cd ~/Desktopmkdir reptilecd reptile -
Clone the repo:
Terminal window git clone git@github.com:Columbia-DESDR/Reptile.git -
Optional: Switch branches with
git checkout [branch-name]
if needed.
Step 3: Run Reptile Locally
-
In the reptile folder, you should see a
requirements.txt
file. Run the command to install dependencies:Terminal window pip install -r requirements.txt -
Set up Flask environments based on your operating system:
- Windows:
Terminal window set FLASK_APP=app.pyset FLASK_ENV=development- Mac/Linux:
Terminal window export FLASK_APP=app.pyexport FLASK_ENV=development -
Start the site:
Terminal window flask run -
Terminal will give you a local URL (like
http://127.0.0.1:xxxx/
). Paste it in your browser to see your site live!