Developer Guide

Here we'll describe what needs to be known in order to build upon our project:

Prerequisites

1. Python.
2. Mongodb (version 3.4).
3. Git client.
4. Github account.

First steps

You first need to fork our project, by forking https://github.com/TechnionYearlyProject/TheDoors

Then follow the installation instructions given in the "Installation Instructions" page in order to install all the dependencies of the project (skip the clone step).

Backend Development

The simulation engine code and some basic API for working with the database are in the "common" directory.

The rest of our backend code is in the "models" directory and you should write your backend code there as well. These are our current files (and what they contain):

1. Analytics - the analytics code (room occupancy, statistics, etc)
2. Order - the code for putting a room order in the system.
3. Schedule - the code that represents a weekly schedule of a user.
4. User - the code that represents a user in the system.
5. facilities - the code that represents facilities table in the DB
6. friends - the code for addition and removal of friends.

Frontend Development

1. Images and other static assets need to be added to the "static" directory.
2. HTML pages should be written under "templates" directory.
3. All your Flask/RESTful code should be written in main.py

Tests

Tests should be written under the "tests" directory, where each test name (that is, each test function name) needs to be prefixed with "test_" since we're working with pytest and it's a requirement of this test suite.

You can run tests with the following command (run a specific module):

 pytest test_backend.py

Or the following (run all tests in a directory):

 pytest tests/