Giter Site home page Giter Site logo

akhm7 / marketplace Goto Github PK

View Code? Open in Web Editor NEW

This project forked from vladimirmonolith/marketplace

0.0 0.0 0.0 58 KB

Oнлайн-магазин бытовой техники. Реализован с помощью FastAPI. Используется асинхронный подход к запросам с базе данных.

License: MIT License

Shell 0.64% Python 98.12% Dockerfile 1.24%

marketplace's Introduction

Cервис Marketplace

Python FastAPI Асинхронность Cookies JWT PostgreSQL Alembic SQLAlchemy Docker Redis Celery Sentry Prometheus Grafana Uvicorn Gunicorn

Описание

API онлайн-магазина бытовой техники.

Доступный функционал

  • Регистрация пользователей с помощью библиотеки fastapi-users.
  • Аутентификация реализована с помощью куков и JWT-токена.
  • У неаутентифицированных пользователей доступ к API только на уровне чтения.
  • Создание объектов разрешено только аутентифицированным пользователям.
  • Возможность получения подробной информации о себе.
  • Загрузка тестовых данных в БД.
  • Возможность осуществить операции CRUD для категорий.
  • Возможность получить список всех товаров подкатегории и выполнить операции CRUD.
  • Возможность получить подробную информацию о товаре и выполнить операции CRUD.
  • Отправка email с подтверждением покупки пользователя посредством Celery.
  • Возможность администрирования сервиса.
  • Версионирование API.
  • Кеширование/брокер задач с помощью Redis.
  • Логирование посредством кастомного логгера.
  • Мониторинг ошибок с помощью Sentry.
  • Сбор метрик с помощью Prometheus.
  • Визуализация метрик посредством Grafana.
  • Возможность развернуть проект в Docker-контейнерах.

Локально документация доступна по адресу: http://localhost:8000/v1/docs/

В контейнерах Docker документация доступна по адресу: http://localhost:7777/v1/docs/

Технологии

  • Python 3.9
  • FastAPI
  • fastapi-cache2
  • Асинхронность
  • Cookies
  • JWT
  • Alembic
  • SQLAlchemy
  • Docker
  • PostgreSQL
  • Asyncpg
  • CORS
  • Redis
  • Celery
  • Flower
  • Sentry
  • Prometheus
  • Grafana
  • Uvicorn
  • Gunicorn

Локальный запуск проекта

  • Предварительно необходимо установить Docker и Redis для вашей системы.

  • Склонировать репозиторий:

    git clone <название репозитория>

Cоздать и активировать виртуальное окружение:

Команды для установки виртуального окружения на Mac или Linux:

    python3 -m venv env
    source env/bin/activate

Команды для Windows:

    python -m venv venv
    source venv/Scripts/activate
  • Перейти в директорию app:
    cd /app
  • Создать файл .env по образцу:
    cp .env-local-example .env
  • Установить зависимости из файла requirements.txt:
    cd ..
    pip install -r requirements.txt
  • Для создания миграций выполнить команду:
    alembic init migrations
  • В папку migrations в env файл вставьте следующий код:
from logging.config import fileConfig

from alembic import context
from sqlalchemy import engine_from_config, pool

from app.categories.models import Category
from app.config import settings
from app.database.db import Base
from app.goods.models import Goods
from app.purchases.models import Purchase
from app.subcategories.models import Subcategory
from app.users.models import User

config = context.config

config.set_main_option('sqlalchemy.url', f'{settings.DATABASE_URL}?async_fallback=True')

if config.config_file_name is not None:
    fileConfig(config.config_file_name)

target_metadata = Base.metadata
  • Инициализировать БД:
    alembic revision --autogenerate -m "comment"   
  • Применить миграцию:
    alembic upgrade head 
  • Запустить проект:
    uvicorn app.main:app --reload    
  • Запустить Redis:
    redis-server.exe 
    redis-cli.exe  
  • Запустить Celery:
    celery -A app.tasks.celery:celery worker --loglevel=INFO --pool=solo
  • Запустить Flower:
    celery -A app.tasks.tasks:celery flower

Запуск в контейнерах Docker

  • Находясь в главной директории проекта:

  • Создать файл .env-docker по образцу:

   cp .env-docker-example .env-docker 
  • Запустить проект:
    docker-compose up -d --build  

Примеры некоторых запросов API

Регистрация пользователя:

   POST /users/register

Получение данных своей учетной записи:

   GET /users/me 

Добавление покупки:

   POST /purchases

Получение списка категорий:

   GET /categories 

Получение списка всех товаров подкатегории:

   GET /subcategories/{subcategory_id}/goods

Загрузка тестовых данных:

   POST /import/{table_name}

Полный список запросов API находится в документации

Автор

Гут Владимир - https://github.com/VladimirMonolith

marketplace's People

Contributors

vladimirmonolith avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.