Copyright 2018 Concordia University
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Infrastructure Information:
Digital Ocean Ubuntu Server: 165.227.34.184
Continuous Integration (Jenkins) URL: http://165.227.34.184:8080
Notifications of builds sent to Slack channel: #jenkinsnotifications
Github Repository: https://github.com/SteveLocke/SOEN490
The app uses the following tools:
Docker is used for the deployment of the software in production only.
As a developer you will need to perform the following steps:
To enforce commit rules we implement some commit hooks that run linting and check that commit messages are properly linked. To set them up run the following command the first time you setup the repository
sh scrips/setup_hooks.sh
- Install virtualenv
pip3 install virtualenv
- Create a venv folder where it will contain all the virtual environments
mkdir venv
cd venv
- Create virtual environment
virtualenv CapstoneReservation -p python3
- Run virtual environment
source CapstoneReservation/bin/activate
- Go inside the the virtual environment directory and clone the project
cd CapstoneReservation
git clone [email protected]:SteveLocke/CapstoneReservation.git
- Go inside the repository and upgrade pip to the latest version
cd CapstoneReservation
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python get-pip.py
The application depends on environment variables stored in .env
- Create .env
cp .env.config .env
-
Install MySQL through this link: https://www.digitalocean.com/community/tutorials/how-to-create-a-django-app-and-connect-it-to-a-database
-
Configure /etc/my.cnf:
[client]
database = capstone_room_reservation
user = db_user
password = db_password
default-character-set = utf8
- Connect to MySQL and create our database
CREATE DATABASE capstone_room_reservation;
The application is dependent to an internal LDAP server. So, you will have to make a SSH tunnel to get access.
- Create a SSH tunnel
sudo ssh -vvv -N -L 0.0.0.0:636:[LDAPServer]:636 [ENCS_username]@login.encs.concordia.ca
where LDAPServer can be one of the following server:
- faith.encs.concordia.ca
- charity.encs.concordia.ca
- hope.encs.concordia.ca
- love.encs.concordia.ca
- Install python dependencies
pip3 install -r server/requirements/dev.txt
- Go to the root directory of the Django app
cd server
- Create migrations
python3 manage.py makemigrations
This will basically look at the DB schema and create scripts to update it if necessary.
- Apply migration changes to the DB
python3 manage.py migrate
This will execute the scripts generated previously from makemigrations and apply the new schema.
- Create super user
python3 manage.py createsuperuser
This will create an user to access to the Django administration interface
- Start Django server
python3 manage.py runserver 0.0.0.0:8000
Celery is used to schedule asynchronous tasks such as sending emails. You must have RabbitMQ running.
To run a worker use the following command:
celery -A config worker -l info --concurrency=1
The concurrency parameter is important if you are using the ICS export feature. This will limit how fast tasks will be completed so if ICS exporting is not used that parameter should be excluded
To run the beat scheduler for periodic tasks, use the following command:
celery -A config beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler
-
Follow the steps to install yarn on https://yarnpkg.com/en/docs/install
-
Go to the root directory of the React app
cd client // or cd ../client (dependending on your current directory)
- Install node dependencies
yarn install
Any yarn (or npm) command has to be run on the same directory as package.json
- Start React app
yarn start
The default port of the React app is 3000
server/ : Django server
└─ apps/ : Django apps
└─ config/ : Django configs
│ └─ settings/ : Django settings (dev/prod)
└─ requirements/ : Python requirements (dev/prod)
└─ scripts/ : Utility scripts
client/ : React app
└─ src/ : Source code
│ └─ assets : Assets
│ | └─ img/ : media files
│ | └─ scss/ : .scss stylesheets (common)
| └─ components/ : React components
| └─ config/ : Configs
└─ dist/ : Minified code for production
- List all Django commands
python3 manage.py --help
- Dump DB (MySQLite)
python3 scripts/dump_database.py
- Dump DB (MySQL)
./scripts/dump_database.sh
- Populate DB
./scripts/populate_db.sh
- Deactivate virtual environment
deactivate
- Run all Django tests
python3 manage.py test apps
- Generate Database Schema
python manage.py graph_models -a -o models.png
Installation of graphviz in your system is required before running this command
To import external ICS events sent to a gmail account, that gmail account needs to activate the Gmail API. One can do so the following Link: https://developers.google.com/gmail/api/quickstart/python
Store the resulting credentials.json file at
server/apps/booking_exporter/GmailImporter
The first time the server is run with these credentials a browser window will open with the google authentication flow.