Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 1.56 KB

README.md

File metadata and controls

55 lines (37 loc) · 1.56 KB

A simple parody of TikTok

Example Lightweight API for building tiktok-like applications

Requirements

Features API

  • Full async
  • Simple jwt auth
  • VIDEO: Viewing video feed, add video, play video(streaming response), like/dislike video, comment
  • USER: create, view, follow, simple profile
  • Storing uploaded videos on a local server(default) or AWS S3 platform(azure cloud, yandex cloud) -> need change conf
  • Encoding uploaded videos with ffmpeg

Quick Start

Rename env_template -> .env and edit.

docker-compose up -d --build

Automatic interactive documentation with Swagger UI (from the OpenAPI backend): http://app.localhost/api/v1/docs/

Alternative automatic documentation with ReDoc (from the OpenAPI backend): http://app.localhost/api/v1/redoc/

Traefik UI, to see how the routes are being handled by the proxy: http://localhost:8080

Create the first migration and apply it to the database:

docker-compose exec app aerich init-db

Create Migration

Make a change to the model. Then, run:

docker-compose exec app aerich migrate
docker-compose exec app aerich upgrade

FFmpeg to encode uploaded videos

Video and audio encoding for playback in Android and iOS devices