Skip to content

Sous-Vide-Zen/backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sous-Vide Zen Backend

linter PyTest

Sous-Vide Zen is a website for sharing and discovering recipes for sous-vide cooking, a technique that involves cooking food in vacuum-sealed bags at precise temperatures. Users can create their own recipes, browse popular and featured recipes, follow other users, react and comment on recipes, and save their favorites.

Features

  • Registration and authorization on the site
  • Share recipes
  • Popular recipes feed
  • Subscription feed
  • Share recipes
  • Comment recipes
  • Reactions to recipes and comments
  • Favorite recipes
  • Hash tags
  • Search recipe database

Technologies

  • Python 3.11
  • Django 4.2.6
  • Django REST Framework 3.14.0
  • PostgreSQL
  • Djoser
  • Black

How to start a project:

Clone the repository:

git clone [email protected]:Sous-Vide-Zen/backend.git

Navigate to the project directory:

cd ./backend/

Create and activate the virtual environment, install dependencies:

  • Windows
python -m venv venv
. venv/Scripts/activate
pip install -r src/requirements.txt
  • Linux and macOS
python3.11 -m venv venv
. venv/bin/activate
pip install -r src/requirements.txt

Navigate to the config directory

cd config/

Create an env file and, if necessary, fill it with your variables or use default values.

cp .env.example .env

Return to the project directory:

cd ..

Launch a project:

python manage.py migrate
python manage.py runserver

Fill the database:

python manage.py loaddata $(ls src/fixtures/)

Documentation url

http://127.0.0.1:8000/api/v1/swagger/

Oauth endpoints:

Эндпоинты регистрации через соц.сети
http://127.0.0.1:8000/api/v1/login/yandex-oauth2/ - регистрация через яндекс
http://127.0.0.1:8000/api/v1/login/vk-oauth2 - регистрация через вк

Настройка редиректа, на проде нужно поменять 127.0.0.1:8000 на домен
http://127.0.0.1:8000/api/v1/complete/yandex-oauth2/ 
http://127.0.0.1:8000/api/v1/complete/vk-oauth2/ - настраивается в vk.com/dev

Releases

No releases published

Packages

No packages published