Skip to content

codeblossom99/wiki

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

My Tech Wiki

English | 繁體中文

A personal tech wiki for articles, notes, and technical documentation.

Next.js TypeScript Tailwind CSS shadcn/ui FastAPI SQLAlchemy PostgreSQL Markdown

Development

Quick start (root)

pnpm install          # install concurrently
pnpm install:web      # install frontend deps
pnpm install:api      # create venv + install backend deps
pnpm dev              # run FastAPI (8000) + Next.js (3000) together

Backend only (port 8000)

cd backend
python -m venv .venv && source .venv/bin/activate
pip install -r requirements.txt
uvicorn app.main:app --reload

API docs: http://localhost:8000/docs

Frontend only (port 3000)

cd frontend
pnpm install
pnpm dev

Tests

pnpm test   # or: cd backend && pytest

API

Method Path Description
GET /api/articles?q=&tag=&category= List / search articles
GET /api/articles/{slug} Get one article
POST /api/articles Create article
PUT /api/articles/{slug} Update article
DELETE /api/articles/{slug} Delete article
GET /api/categories Category counts

Environment variables

  • DATABASE_URL (backend): defaults to sqlite:///./wiki.db; use postgresql+psycopg://... in production
  • CORS_ORIGINS (backend): defaults to http://localhost:3000
  • NEXT_PUBLIC_API_BASE (frontend): defaults to http://localhost:8000

About

No description, website, or topics provided.

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors