History

jedi 756fe4aaad All checks were successful / test (push) Successful in 2m38s Details / deploy (push) Successful in 4m36s Details add README.md		2025-03-16 14:24:44 +01:00
..
.local	fix bug in initial db creation caused by prometheus lib rtying to access tables at load time	2025-03-09 21:27:19 +01:00
authentication	drop v1 API and rename id columns	2024-12-05 00:50:12 +01:00
core	fix bug in initial db creation caused by prometheus lib rtying to access tables at load time	2025-03-09 21:27:19 +01:00
files	remove duplicate code in files.models.FileManager	2025-02-09 19:38:17 +01:00
inventory	show all item timestamps in timeline	2025-02-09 19:23:29 +01:00
mail	added a check in the make_reply function to ensure that mails have a body	2025-02-09 17:24:42 +01:00
notify_sessions	add notify_sessions module	2024-01-07 21:16:34 +01:00
tickets	created missing migration	2025-03-15 22:40:09 +01:00
.coveragerc	add event mail addresses to the /events endpoints	2024-12-05 00:30:04 +01:00
.gitignore	add django backend in /core	2023-11-18 12:57:50 +01:00
helper.py	add requirements.dev.txt	2024-01-07 17:26:20 +01:00
manage.py	add django backend in /core	2023-11-18 12:57:50 +01:00
README.md	add README.md	2025-03-16 14:24:44 +01:00
requirements.dev.txt	remove unnecessary packages from requirements.dev.txt	2025-03-15 21:03:42 +01:00
requirements.prod.txt	Add django standard metrics	2024-12-05 00:30:04 +01:00
server.py	add requirements.dev.txt	2024-01-07 17:26:20 +01:00

Core

This directory contains the backend of the C3LF System3 project, which is built using Django and Django Rest Framework.

Modules

authentication: Handles user authentication and authorization.
files: Manages file uploads and related operations.
inventory: Handles inventory management, including events, containers and items.
mail: Manages email-related functionalities, including sending and receiving emails.
notify_sessions: Handles real-time notifications and WebSocket sessions.
tickets: Manages the ticketing system for issue tracking.

Most modules follow a similar structure, including the following components:

<module>/models.py: Contains the database models for the module.
<module>/serializers.py: Contains the serializers for the module models.
<module>/api_<api_version>.py: Contains the API views and endpoints for the module.
<module>/migrations/: Contains database migration files. Needs to contain an __init__.py file to be recognized as a Python package and automatically migration creation to work.
<module>/tests/<api_version>/test_<feature_model_or_testcase>.py: Contains the test cases for the module.

follow the instructions under 'Backend-API-Only' or 'Fullstack-Lite' in the root level README.md to set up a development environment.

The project follows a TDD workflow to ensure code quality and reliability. Here is a step-by-step guide to the TDD process:

Write a Test: Start by writing a test case for the new feature or bug fix. Place the test case in the appropriate module within the <module>/tests/<api_version>/test_<feature_model_or_testcase>.py file.
Run the Test: Execute the test to ensure it fails, confirming that the feature is not yet implemented or the bug exists.
```
python manage.py test
```
Write the Code: Implement the code required to pass the test. Write the code in the appropriate module within the project.
Run the Test Again: Execute the test again to ensure it passes.
```
python manage.py test
```
Refactor: Refactor the code to improve its structure and readability while ensuring that all tests still pass.
Repeat: Repeat the process for each new feature or bug fix.

The project uses the coverage package to measure test coverage. To generate a coverage report, run the following command:

coverage run --source='.' manage.py test
coverage report

For more detailed information on the project structure and development modes, refer to the root level README.md.