https://github.com/romanpecheritsa/habitreminder

The Habit Reminder API is a Django REST Framework-based backend for managing personal habits. It allows users to create, track, and share habits with customizable settings like periodicity, duration, and rewards. The API supports authentication, ensuring users can manage their habits securely while also accessing public habits shared by others
https://github.com/romanpecheritsa/habitreminder

celery celerybeat django-rest-framework drf-spectacular postgresql redis simplejwt

Last synced: 17 days ago
JSON representation

The Habit Reminder API is a Django REST Framework-based backend for managing personal habits. It allows users to create, track, and share habits with customizable settings like periodicity, duration, and rewards. The API supports authentication, ensuring users can manage their habits securely while also accessing public habits shared by others

• Host: GitHub
• URL: https://github.com/romanpecheritsa/habitreminder
• Owner: RomanPecheritsa
• Created: 2024-11-30T21:34:43.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-12-13T10:36:59.000Z (21 days ago)
• Last Synced: 2024-12-13T11:29:16.938Z (21 days ago)
• Topics: celery, celerybeat, django-rest-framework, drf-spectacular, postgresql, redis, simplejwt
• Language: Python
• Homepage:
• Size: 89.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Habit Reminder

## Overview

he Habit Reminder API is a Django REST Framework-based backend for managing personal habits. It allows users to create, track, and share habits with customizable settings like periodicity, duration, and rewards. The API supports authentication, ensuring users can manage their habits securely while also accessing public habits shared by others

## Installation and Setup with Docker

### 1. Clone the Repository

```bash

git clone [email protected]:RomanPecheritsa/HabitReminder.git

cd HabitReminder

```

### 2. Copy the env.example file to .env:

Open.env and replace the values of the variables with your own

```bash

cp .env.example .env

```

### 3. Build and Run Docker Containers

Execute the following command to build the Docker images:

```bash

docker-compose build

```

Start the application and its dependencies using:

```bash

docker-compose up

```

The server will be available at http://127.0.0.1:8000

### 4. Testing the Application

Run the tests with coverage: This command runs the Django tests and collects coverage data:

```bash

docker exec -it django coverage run --source='.' manage.py test

docker exec -it django coverage report

```

### 5. Stopping and Cleaning Up Docker Containers

To stop the running containers, use:

```bash

docker-compose down

```

If necessary, remove unused containers and images to free up space

```bash

docker system prune -a

```

### 6. Documentation

The full API documentation is available at: http://127.0.0.1:8000/swagger/