A simple API for managing health journal entries.
-
Clone the repository.
-
Create and activate a virtual environment.
python -m venv venv
source venv/bin/activate
-
Copy the
.env.example
file to.env
and update the values.cp .env.example .env
-
Install the dependencies.
pip install -r requirements.txt
-
Set up the database. The project was bult using a PostgreSQL database.
python manage.py migrate
-
Run the server.
-
Create a superuser.
python manage.py createsuperuser
-
Access the admin panel at
http://localhost:8000/admin/
and create a few categories. -
Access the API documentation at
http://localhost:8000/developer/docs
orhttp://localhost:8000/developer/doc
.
- User Management User registration and authentication (JWT or session-based). Profile management.
- Journal Entry Management CRUD operations for journal entries. Categorization of entries.
- Data Summary Endpoints to fetch summary data for given periods.
- Security Ensure all endpoints are secure and accessible only by authenticated users. Database Use a relational database like PostgreSQL or MySQL.
- Add more tests.
- Add/Activate more features like reminders, notifications, etc.
- Add more data summary endpoints.
- Add more security features like rate limiting, etc.
- Add more documentation.
- Add more error handling.
- Add more features like search, filtering, etc.