Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,22 +62,20 @@ A minimalist open-source alternative to Canny / Frill.

## Architecture
```
src/
├── app/ # App Router (routes, layouts, loading, error, OG)
│ ├── (auth)/ # public auth pages
│ ├── (dashboard)/ # protected admin pages
│ ├── (marketing)/ # landing
│ └── b/[slug]/ # public board + roadmap + post detail
├── components/
│ ├── ui/ # shadcn primitives
│ ├── posts/ board/ # domain components
│ ├── posts/ board/ shared/ # domain components
├── lib/
│ ├── auth.ts # Auth.js config
│ ├── db.ts # Prisma singleton
│ └── validators/ # shared Zod schemas
└── server/
├── actions/ # Server Actions (mutations)
└── queries/ # Read functions for Server Components
├── actions/ # Server Actions (mutations)
└── queries/ # Read functions for Server Components
```
**Key decisions** — see [docs/decisions.md](./docs/decisions.md) for the full log.

Expand Down Expand Up @@ -108,7 +106,8 @@ Then visit `http://localhost:3000` and `http://localhost:3000/b/demo`.
### Generate `AUTH_SECRET` & `CRON_SECRET`

```bash
openssl rand -base64 32
openssl rand -base64 32 # AUTH_SECRET
openssl rand -base64 32 # CRON_SECRET
```

## Scripts
Expand All @@ -131,8 +130,8 @@ npm run db:studio # browse the DB
npm test

# E2E tests (Playwright) — full user flows
npm run e2e:db:up # start Postgres in Docker
npm run e2e:db:reset # apply migrations
# Requires a separate Neon branch — set DATABASE_URL in .env.test
npm run e2e:db:reset # reset DB + seed (destructive)
npm run test:e2e # run Chromium against a fresh build
npm run test:e2e:ui # interactive mode
```
Expand All @@ -151,7 +150,7 @@ One-click deploy on Vercel:

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/Yentec/FeedbackFlow.git)

You will need to set all environment variables from `.env.example` in the Vercel project.
You will need to set all production environment variables from `.env.example` in the Vercel project. E2E-specific variables (local Postgres, test secrets) are in `.env.test.example`.

## Roadmap

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "feedbackflow",
"version": "1.0.5",
"version": "1.0.6",
"private": true,
"scripts": {
"dev": "next dev",
Expand Down
Loading