⛴ Software for planning SeaWatch's rescue operations

SeaWatch Planner is an application which should support SeaWatch by planning their operations. It allows volunteers to register theirself to help SeaWatch. These volunteers create a profile with availabilitys where they have time to volunteer for SeaWatch Operations. SeaWatch Planner allows the crewing staff to use these Informations in their crewing process and request documents and other information of the volunteers.

To run the application you have to use docker, you will find the installation instructions on https://docs.docker.com/v17.12/install/.

After you downloaded or cloned the repository switch to the directory containing the file docker-compose.yml and run

docker-compose up -d (-dstarts the containers in a detached mode (containers run in background)).

The Django app and the database will then start up.

To create a superuser (you will need it to enter the admin interface) run

docker exec -it seawatch_planner_web_1 python manage.py createsuperuser

The application can be reached at localhost:8001/.

The admin interface can be reached at localhost:8001/admin.

If you want to change the ports edit them in the docker-compose.yml file.

For testing the application, start the app as described before. Then run the following command:

docker exec -it seawatch_planner_web_1 python manage.py test

We decided to use the the following coding conventions.

• Use PEP 8 coding style.
• If possible use Djangos generic class based views, for example ListView, CreateView, DetailView, UpdateView and DeleteView.
• ListViews are often represented with tables. For each dataset you have actions like delete this dataset of go to detail view. These actions are represented by links with fontawesome icon in the table and not by buttons.
• General actions like add a new dataset are represented by buttons with fontawesome icons outside of the table.
• Use the following table as an example for the url paths, the naming of the class of the views and the view name itself: