GoodParty.org Webapp

Website: https://goodparty.org

Coding styles

We are using conventional commits

Built With

• Next.js - React SSR Framework
• Tailwind CSS - CSS library
• Material UI - UI Library
• Clerk - Authentication

Get Started

1. Copy the example env file and fill in your values:

cp .env.example .env.local

2. Install dependencies and run:

npm install
npm run dev

To run with dev API:

npm run dev-dev

Environment Variables

See .env.example for the full list. The required variables for local development are:

Variable	Description
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY	Clerk publishable key (from Clerk dashboard)
CLERK_SECRET_KEY	Clerk secret key (from Clerk dashboard)
NEXT_PUBLIC_API_BASE	gp-api URL (defaults to dev)
NEXT_PUBLIC_SEGMENT_WRITE_KEY	Segment analytics write key
NEXT_PUBLIC_AMPLITUDE_API_KEY	Amplitude analytics API key

Styleguide

our styleguide lives on style.goodparty.org and uses storybook.
To run it locally run

npm run storybook

You will need to run also the api for the project https://github.com/thegoodparty/tgp-api

AI-Assisted Development

We use Claude Code for AI-assisted development. Project-specific context lives in CLAUDE.md at the repo root. If you find yourself teaching the AI the same thing more than once, add it to CLAUDE.md so all future sessions (for the whole team) benefit.

The ai-rules/ directory is a git submodule containing rule files for AI code review critics. After cloning, initialize it with git submodule update --init. To pull the latest rules: npm run ai-rules:update.

License

This project is licensed under the Creative Common Zero (CC0) License