headless-forum-fastapi
headless-forum-fastapi copied to clipboard
sinisaos
Backend for simple forum made with FastAPI and Piccolo ORM ecosystem.
trafficstars
Backend for simple forum made with FastAPI and Piccolo ORM ecosystem.
Instalation
Clone repository in fresh virtualenv.
git clone https://github.com/sinisaos/headless-forum-fastapi.git
Install requirements
cd headless-forum-fastapi
pip install -r requirements/requirements.txt
Create database
sudo -i -u yourpostgresusername psql
CREATE DATABASE forum;
\q;
Setup
Create .env file in root of the project.
DB_NAME=your db name
DB_USER=your db username
DB_PASSWORD=your db password
DB_HOST=your db host
DB_PORT=your db port
SECRET_KEY=your secret key
ALGORITHM="HS256"
ACCESS_TOKEN_EXPIRE_MINUTES=30
Migrations
./scripts/migrations.sh
Create admin user
./scripts/user.sh
Testing
Install test requirements.
pip install -r requirements/test-requirements.txt
Run tests.
./scripts/test.sh
Linting
./scripts/lint.sh
Getting started
./scripts/start.sh
After site is running log in as admin user on localhost:8000/admin/ and add categories, topics etc.
For non admin user go to API docs localhost:8000/docs/ where you can register.
After that you can login with Authorize button to access protected routes.
sinisaos