Welcome to Synoptic! This README is designed to help you get started with coding quickly and easily.
To install the required dependencies, follow these steps:
-
Make sure you have Python 12 installed on your system.
-
Fork the project and clone the fork to your local machine.
-
Navigate to the project directory.
-
Run the following command to install the dependencies from the
requirements.txtfile:pip install -r requirements.txt
I chose VS Code for this project since you probably want to learn it before pycharm becomes a paid product
-
you will need to install following extensions:
- Ruff: Installation instructions
- Djlint: Installation instructions
- Docker: Installation instructions
- Python: Installation instructions
In this project, we are using the following technologies:
- htmx: A JavaScript library for AJAX interactions in the browser.
- daisyUI: A CSS framework for rapidly building custom designs.
- alpine.js: A lightweight JavaScript framework for building interactive web interfaces.
The project follows a standard Django project structure and consists of three apps: manager, public, and sensor. Here's a brief overview of each app:
The manager app is responsible for managing the charity manager that are able to login to the app.
The public app handles the public-facing functionality of the project. It includes features such as public pages, user registration, and public APIs. This app is accessible to all users of the project.
The sensor app deals with sensor-related functionality.
Feel free to explore each app's directory for more details on their specific functionality and implementation.
django-admin makemessages -a to create/update django.po for the languages
django-admin compilemessages to compile the language for user submission.
Tip
Make sure you are in the same directory as manage.py when running the above commands.
Note
This README was written with copilot so best not include it in final submission