Project Setup

Technologies Used (+ Installation Links):

• Django 1.11.X
• Python 2.7.X
• jQuery 3.X
• Javascript
• Celery
• RabbitMQ
• PostgreSQL 10.X
• Heroku

---

Installation Guide:

Note: Step 8 is optional.

0. IMPORTANT! Decide where to keep the project and clone the repo using the clone the repo on the home page

1. Install Python 2.7.15 and pip. Linked above

   • [Windows] Download get-pip.py file. Install using: python install get-pip.py
   • [macOS] Follow the this guide.

2. Install PostgreSQL and initialize the default schema. Linked above

   • [macOS] Suggest using Postgres.app as it is a lot simpler. https://postgresapp.com/
   • Initialize a default database with name reboot and superuser root
   • [macOS] Try running the shell script sh scripts/start_db.sh; sh scripts/create_db.sh (A talented friend wrote it for another project). It may or may not work
   • Otherwise, reference https://wiki.postgresql.org/wiki/First_steps

3. Open Terminal and install virtualenv

pip install virtualenv

4. Inside the repo, use the setup command

cd reBOOT/
make setup

5. Launch your virtualenv

# Windows
venv\Scripts\activate
# macOS / Linux
source venv/bin/activate

6. Make a local copy of the .env.sample file and rename it to .env

7. Install rabbitMQ using brew install rabbitmq on a Mac or the above link

8. Install Heroku CLI through the link above

---

Project Launch Guide:

Note: Step 2 will have to be run occasionally when there are database changes to be initialized or to be made.

1. Run the default command after activating the virtualenv

# venv/Scripts/activate OR source venv/bin/activate
make

2. Run database migration

make migrate

3. Hopefully, it worked for you 👍

4. Exit the project

make exit