Skip to content

README.md

Latest commit

 

History

History
58 lines (41 loc) · 1018 Bytes

README.md

File metadata and controls

58 lines (41 loc) · 1018 Bytes

Puffnotes

Puffnotes is a simple markdown notes app for writing, editing, and managing notes in one place.

The app is hosted on Railway: https://puffnotes.up.railway.app

Tech Stack

  • React 19
  • TypeScript
  • Vite
  • Tailwind CSS
  • TipTap editor
  • Clerk authentication
  • Go
  • PostgreSQL
  • Railway

Running Locally

1. Add your environment variables

Copy .env.example to .env and update the values.

CLERK_SECRET_KEY=
VITE_CLERK_PUBLISHABLE_KEY=
VITE_API_BASE_URL=http://localhost:8080
DB_URL=postgres://postgres:postgres@localhost:5432/puffnotes
HTTP_PORT=:8080

2. Start the frontend

cd frontend
npm install
npm run dev

The frontend runs on http://localhost:5173.

3. Start the backend

Make sure PostgreSQL is running first, then run:

cd backend
go run ./cmd/server

The API runs on http://localhost:8080.

Notes

  • Clerk is used for authentication.
  • Notes are stored in PostgreSQL.
  • The frontend talks to the Go API using VITE_API_BASE_URL.