https://github.com/yukaty/django-recipe-api

Recipe API with Django REST Framework
https://github.com/yukaty/django-recipe-api

django django-rest-framewok docker-compose github-actions

Last synced: 3 days ago
JSON representation

Recipe API with Django REST Framework

• Host: GitHub
• URL: https://github.com/yukaty/django-recipe-api
• Owner: yukaty
• Created: 2024-03-01T23:13:17.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-08-29T01:45:42.000Z (4 months ago)
• Last Synced: 2024-11-10T20:04:22.928Z (2 months ago)
• Topics: django, django-rest-framewok, docker-compose, github-actions
• Language: Python
• Homepage: http://ec2-35-175-193-174.compute-1.amazonaws.com/api/docs/
• Size: 43.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Recipe API

![GitHub Actions workflow status](https://github.com/yukaty/django-recipe-api/actions/workflows/checks.yml/badge.svg)

Recipe API with Python and Django provides a platform for users to manage recipes.

## Features

- User Authentication

- Recipe Management

- Image Uploads

- Filtering and Sorting

## Technologies

- Python & Django for backend development

- Django REST Framework for building RESTful APIs

- Docker & Docker Compose for containerization

- GitHub Actions for continuous integration and test automation

- PostgreSQL as the database

- Swagger for automated API documentation

- AWS EC2 for deployment

- Test Driven Development (TDD)

## Quick Start

1. Clone the repository and navigate into the project directory:

   ```bash

   git clone https://github.com/yukaty/django-recipe-api.git

   cd django-recipe-api

   ```

2. Set up environment variables by copying the provided `.env.sample` file:

    ```bash

    cp .env.sample .env

    ```

3. Start the services:

   ```bash

   docker compose up --build

   ```

## API Documentation

Visit the Swagger UI at: http://localhost:8000/docs

## Development

- Update database schema:

  - Edit `app/core/models.py` and run migrations

- Run tests:

  - `docker compose run --rm app sh -c "python manage.py test"`

- Modify API endpoints:

  - Edit files in `app/`