https://github.com/thejasmeetsingh/generic-notes
A basic notes management backend application
https://github.com/thejasmeetsingh/generic-notes
django django-rest-framework docker gunicorn jwt-authentication python3 restful-api uvicorn
Last synced: 3 months ago
JSON representation
A basic notes management backend application
- Host: GitHub
- URL: https://github.com/thejasmeetsingh/generic-notes
- Owner: thejasmeetsingh
- Created: 2024-02-18T13:20:17.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-29T06:37:04.000Z (over 1 year ago)
- Last Synced: 2025-01-21T17:30:17.071Z (4 months ago)
- Topics: django, django-rest-framework, docker, gunicorn, jwt-authentication, python3, restful-api, uvicorn
- Language: Python
- Homepage:
- Size: 28.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Generic Notes
A simple note management application built with Python3, Django, Django Rest Framework (DRF), and PostgreSQL. The application is containerized with Docker for easy setup and deployment, ensuring compatibility across different platforms. It leverages Gunicorn as the WSGI HTTP Server with Uvicorn workers to handle asynchronous requests efficiently. Also dedicated logger is added to get detail of each request and or any error.
## Features
- **User Management:** Users can sign up and log in to the application.
- **Note Creation:** Authenticated users can create notes.
- **Note Update:** Users can update their notes.
- **Note Sharing:** Users can share notes with other users, granting them view or update access.
- **Version History:** Users can view the version history of a note, tracking changes made, the author of the changes, and the timestamps of those changes.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
1. Install [docker](https://www.docker.com/products/docker-desktop/).
2. Clone the repository.
3. Navigate to the project directory.
4. Start the application by running command: `docker-compose up -d`.
5. After the containers are up and running, you can access the API endpoints via `http://localhost:8000`.
[
](https://app.getpostman.com/run-collection/17396704-f5adf0f8-4c30-42ce-9212-ea179f294826?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D17396704-f5adf0f8-4c30-42ce-9212-ea179f294826%26entityType%3Dcollection%26workspaceId%3D392b781a-05ab-415b-9eb8-456aca6f3129)
To run automated tests for the application, execute the command: `docker container exec -it app python manage.py test api.tests`.