simssadb

Since this repository has submodule, when you clone it, please use git clone --recursive [email protected]:ELVIS-Project/simssadb.git, so that the submodule can also be cloned.

Installation and Setup for Development (Mac)

• Make sure you have homebrew and python 3.6 or above installed

• Install PostgreSQL with brew install postgresql

• Start the PostgreSQL server with brew services start postgresql

• Start a virtual environment with python3 -m venv venv

• Start virtual environment source venv/bin/activate

• Set up environment variables with: cat env.txt >> ~/.bash_profile and source ~/.bash_profile (NOTE: If you use PyCharm or other IDE, please restart the IDE for the environmental settings to work!)

• Install python packages pip3 install -r requirements.txt

• Setup database:

  > createdb `whoami`
  > createdb ${POSTGRES_DB}
  > createuser ${POSTGRES_USER} -d -e -l -r -s
  > psql -d ${POSTGRES_DB} -c "ALTER DATABASE $POSTGRES_DB OWNER TO $POSTGRES_USER;"
  > psql ${POSTGRES_DB} -c "ALTER USER $POSTGRES_USER WITH PASSWORD '$POSTGRES_PASSWORD';"

• Make migrations: python manage.py makemigrations

• Migrate: python manage.py migrate

• Start a server to see if it worked: python manage.py runserver

• Go to http://127.0.0.1:8000 on your web browser

To set up for development after having completed the above steps:

• Start virtual environment source venv/bin/activate
• Link environment variables source ~/.bash_profile
• Start the server python manage.py runserver
• Go to http://127.0.0.1:8000 on your web browser

See the Wiki for more information:

• User manual
• Setting up the database
• ERD