README.rst

SINGLE BOARD HEATER SYSTEM

INSTALLATION GUIDE

1. Clone from the SBHS Github server

   https://github.com/CruiseDevice/sbhs_server
   

2. Create a virtual environment, using command virtualenv and activate the virtualenv. We recommend using Python 3

   virtualenv myenv -p python3
   source myenv/bin/activate
   

3. Install necessary packages from requirements.txt using command:

   pip install -r requirements.txt
   

4. Add crispy_forms to INSTALLED_APPS in settings.py

5. Make first migrations by using the commands

   python manage.py makemigrations
   python manage.py migrate
   

6. Create superuser by using the command

   python manage.py createsuperuser
   

7. Enter the admin username and email you want, then enter the admin password.

8. Create moderator group by using command

   python manage.py create_moderator
   

9. Update the connected boards by using command

   python manage.py update_boards
   

10. Fill in the necessary information in the file

    sbhs_server/credentials.py.

11. In sbhs_server/settings.py, fill in the following details -

1. Make sure the sbhs_api (https://github.com/CruiseDevice/sbhs_api) is hosted on the slave machines to which SBHS devices are connected.
2. If SBHS devices are connected to a cluster of slave machines and/or master machine (where the Django server is hosted), enter the slave machine IPs and port (if hosted on a specific port) in the variable SBHS_API_IPS.

12. Run the server by using the command

    python manage.py runserver
    

13. Once the server is running successfully, go to the URL http://localhost:8000

    To create a normal user, just fill the registration form and submit. You can the login with the created normal user.

    To create a moderator ::

    • First create a normal user by filling the registration form and submitting it
    • Then go to django admin by entering URL http://localhost:8000/admin
    • Login into admin by using credentials you entered while creating admin in step 6
    • Go to the profile section and click on the user you just created.
    • Tick is_moderator checkbox and click on save.
    • Exit the admin by loggin out of it.

    Now you have created a moderator account. With moderator account you can view state of all the SBHS connected, all the logs of the all the users, all the slots booked by the users, and also the profile of each SBHS.