Setting up for Development - RPI-HASS/rpi_csdt_community GitHub Wiki

Prerequisites

• VirtualBox
  • Linux: sudo apt-get install virtualbox
  • Windows & Mac: https://www.virtualbox.org/wiki/Downloads
• Vagrant
  • Linux: sudo apt-get install vagrant
  • Windows & Mac: https://www.vagrantup.com/downloads.html
• Git
  • Linux: sudo apt-get install git
  • Windows & Mac: https://git-scm.com/downloads
    • For windows Make sure C:\Program Files\Git\usr\bin is in your path variable
• A copy of this repo
  • git clone https://github.com/RPI-HASS/rpi_csdt_community.git

Setup

cd {{ This repo }}
vagrant up # Runs vagrant server
vagrant ssh # Access vagrant box
cd /vagrant/ 
python manage.py test # Runs all tests
python manage.py migrate # Migrates the database
python manage.py runserver 0.0.0.0:8000 # Runs the development server

You should now be able to view the Community Site homepage at http://127.0.0.1:8000/.

When you are done, hit Ctrl+C, and then Ctrl+D to exit.

To start developing read Development Workflow.

Why Vagrant & Virtual Box

Vagrant is a tool that works in conjunction with Virtual Box to help manage development environments that are more complex than an editor and compiler. For this project we need to setup Python, Node, and PostgreSQL. To help simplify this process, we will use Vagrant. There is an excellent tutorial for vagrant here.

Git & This Source Code

This source code along with this wiki live on Github, a server for repositories. They can be accessed with git, a version control system for repositories. You can either use the commandline (which is what is written here and strongly recommended) or the github specific app to download, make, and upload changes to the project.