Online Store API

Django Rest Framework (DRF) API for an online store. The API allows frontend developers to interact with the store's data, including products, categories, sizes, and images.

Table Of Contents

• Key Features
• Technology Stack
• Getting Started
  • Prerequisites
  • Installation
    • Local Development
• API Documentation

Key Features

• Category Management: Organize your products with a flexible category system.
• Product Management: Create, update, and delete products along with their images and sizes.
• Product Filtering: Retrieve products through filters to streamline customer experience.

Technology Stack

• Django & Django REST Framework
• Poetry
• PostgreSQL
• Docker & Docker Compose

Getting Started

Prerequisites

• docker

Installation

Local Development

To get started with local development:

1. Clone the repository:

git clone https://github.com/razllivan/django-florist-app.git &&
cd django-florist-app

2. Copy and rename the sample .env file and set the necessary environment variables:

cp .envs/.local/.env.sample .envs/.local/.env

3. Launch the development services using Docker Compose:

docker-compose -f local.yml up -d --build

After the containers start, the project will be available at http://localhost:8000.

API Documentation

After starting the project, the API documentation will be available at http://localhost:8000/api/docs.