mosesokemwa / be_shamiri_health

Shamiri Health Journal API's

A simple API for managing health journal entries.

Set up and run the backend service.

1. Clone the repository.

2. Create and activate a virtual environment.

   python -m venv venv

   source venv/bin/activate

3. Copy the .env.example file to .env and update the values.

   cp .env.example .env

4. Install the dependencies.

   pip install -r requirements.txt

5. Set up the database. The project was bult using a PostgreSQL database.

    python manage.py migrate

6. Run the server.

7. Create a superuser.

   python manage.py createsuperuser

8. Access the admin panel at http://localhost:8000/admin/ and create a few categories.

9. Access the API documentation at http://localhost:8000/developer/docs or http://localhost:8000/developer/doc.

Features

1. User Management User registration and authentication (JWT or session-based). Profile management.
2. Journal Entry Management CRUD operations for journal entries. Categorization of entries.
3. Data Summary Endpoints to fetch summary data for given periods.
4. Security Ensure all endpoints are secure and accessible only by authenticated users. Database Use a relational database like PostgreSQL or MySQL.

Further Improvements

1. Add more tests.
2. Add/Activate more features like reminders, notifications, etc.
3. Add more data summary endpoints.
4. Add more security features like rate limiting, etc.
5. Add more documentation.
6. Add more error handling.
7. Add more features like search, filtering, etc.