https://github.com/abynxv/remind-me-later-api
A simple Django REST Framework (DRF) API to create reminders. Each reminder belongs to a user and stores a message, date, time, and reminder type (email or SMS).
https://github.com/abynxv/remind-me-later-api
django django-rest-framework python3 service-layer viewsets
Last synced: 13 days ago
JSON representation
A simple Django REST Framework (DRF) API to create reminders. Each reminder belongs to a user and stores a message, date, time, and reminder type (email or SMS).
- Host: GitHub
- URL: https://github.com/abynxv/remind-me-later-api
- Owner: abynxv
- Created: 2025-04-08T11:48:30.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-22T19:10:39.000Z (9 months ago)
- Last Synced: 2025-08-22T21:42:57.227Z (9 months ago)
- Topics: django, django-rest-framework, python3, service-layer, viewsets
- Language: Python
- Homepage:
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Remind Me Later API
A simple Django REST Framework (DRF) API to create reminders. Each reminder belongs to a user and stores a message, date, time, and reminder type (email or SMS).
## Setup
1. **Clone the repository:**
```bash
git clone https://github.com/your-username/remind-me-later-api.git
cd remind-me-later-api
```
2. **Create a virtual environment:**
```bash
python -m venv venv
source venv/bin/activate # Linux / macOS
venv\Scripts\activate # Windows
```
3. **Install dependencies:**
```bash
pip install -r requirements.txt
```
4. **Apply migrations:**
```bash
python manage.py migrate
```
5. **Create a superuser (for managing users in admin):**
```bash
python manage.py createsuperuser
```
6. **Create a test user (optional):**
```bash
python manage.py shell
from django.contrib.auth.models import User
user = User.objects.create(username="abhi", password="123")
print(user.id)
```
7. **Run the server:**
```bash
python manage.py runserver
```
## API Endpoints
### Create Reminder
**POST** `/api/reminder/`
**Request body:**
```json
{
"user": 1,
"message": "Doctor Appointment",
"date": "2025-08-23",
"time": "17:45:00",
"reminder_type": "email"
}
```
**Response (201 Created):**
```json
{
"id": 1,
"user": 1,
"message": "Doctor Appointment",
"date": "2025-08-23",
"time": "17:45:00",
"reminder_type": "email"
}
```
### Get All Reminders
**GET** `/api/reminder/`
**Response (200 OK):**
```json
[
{
"id": 1,
"user": 1,
"message": "Doctor Appointment",
"date": "2025-08-23",
"time": "17:45:00",
"reminder_type": "email"
},
{
"id": 2,
"user": 1,
"message": "Meeting with team",
"date": "2025-08-24",
"time": "09:30:00",
"reminder_type": "sms"
}
]
```