SENG2011

PartyWhip Project Using:
Frontend: Vue, Vuex, Vuetify, Vue-router, Axios..
Backend: Django, PostgreSQL, Django-Rest-Framework, djangorestframework-recursive, django-rest-framework-jwt
DevOps: Docker, Docker-Compose, pgAdmin, Dafny, Django-test

Getting involve

Set Your Working Branch

# create to your branch and working there
$ git checkout -b YOUR_BRANCH_NAME

# when you finshish, push the commits
$ git add && git commmit && git push
# IF you are push this branch FIRST TIME, you may use this line
$ git push --set-upstream origin YOUR_BRANCH_NAME

Docker Environment

First, we need to install: Docker Community Edition and Docker Compose

That's all we need. Then you can type:

# startup the app, use (Ctrl +C) to exit
$ sudo docker-compose up

Or, you don't want that much information, you can:

# Filter out the message of specified service
$ sudo docker-compose up | egrep "frontend"

# Or: detach the message when you up the app
$ sudo docker-compose up -t
# Get the logged messages
$ sudo docker-compose logs
# Shutdown the app
$ sudo docker-compose down

There's a way to attach to the running container, use (Ctrl + D) to exit.

# attach backend
$ ./attach.sh backend
# run create a super user for management
# The id may not be same
root@6da3612aff4c:/usr/src/app# ./manage.py createsuperuser

# attach to frontend
$ ./attach.sh frontend
# add more dependencies
root@8a47db617648:/app# npm i -S @vue/ui

APIs Documents

The api document is in api.http; You need to run it via vscode Rest Client

You can install it via this command in vscode command panel (Ctrl + Shift + P):

ext install humao.rest-client

URLs

URL	Detail
http://localhost:8000/	Index of party whip's
http://localhost:8080/	Home Page (Backend)
http://localhost:8000/admin	Django admin
http://localhost:8081/	pgAdmin: GUI of PostgreSQL