API documentation can be found here
Username: admindemo
Password: ualberta01!
Note: This is a superuser/server-admin account, which would have access to all the posts on our server.
To test the visibility of post, please use normal user
- Django
- ReactJS
- Heroku
- PostgreSQL
Project/
|-- backend # Django API server
|-- src # ReactJS Frontend SPA
|-- public # React Public Folder
|-- Procfile # Heroku config
|-- manage.py # Django manage.py
|-- package.json # Node packages
|-- requirements.txt # Python packages
Make sure you are using python>=3 and pip3
cd CMPUT404-project-socialdistribution/
# Install virtualenv
python3 -m pip install --user virtualenv
python3 -m venv env
# activate the virtualenv
source env/bin/activate
# Install PostgreSQL
brew install postgresql
# Install all python packages
pip3 install -r requirements.txt
# Verify packages are successfully installed
pip3 freeze
Make sure you have node and yarn installed, if not, refer to:
yarn install
yarn add react-scripts
touch .env
echo 'DATABASE_URL={YOUR POSTGRESQL HOST}' > .env
echo 'github_token={GITHUB ACCESS TOKEN}' > .env
For development, we need to run both frontend and backend servers
yarn start
source env/bin/activate
python manage.py migrate
python manage.py runserver
If you are only working on backend, and therefore don't need to worry about the frontend, to make your life easier, you can do
yarn build
source env/bin/activate
python manage.py migrate
python manage.py runserver
For running frontend tests, simply run
yarn test
For running backend tests, run
pytest backend
After executing, it will generate a coverage report inside htmlcov/ folder
Please install the ESLint package for your IDE or Text Editor to help us maintain consistent and clean code. To make sure it is working, try using single quotes instead of double quotes - it should complain with single quotes.