Оформить README.md

[CitizenFourCF4]

Правильно и красиво оформить README.md

[CitizenFourCF4]

Работаем на REST-архитектуре

У нас есть 2 сервера:

• Сервер backend работает на порту 1234. Представляет собой django rest framework сервер.
• Сервер client работает на порту 5173. Представляет собой React сервер

В качестве базы данных используется `PostgreSQL'

Инструкции по установке:

• Backend

  • установить библиотеки из файла requirements.txt
  • создать базу данных в postgresql
  • создать файл .env, содержащий секреты, необходимые для файла settings.py
  • Произвести миграции командами python manage.py makemigrations python manage.py migrate
  • Запустить сервер командой python manage.py runserver

• Frontend

  • Выполнить установку пакетов командой yarn
  • Запустить сервер командой yarn dev

Требования

• python>=3.10
• nodejs >=18
• yarn