7b540a37ee
- Rename project from "kanban" to "pounce" - Update landing page: "Pounce on your tasks" - Replace navbar icon with cat paw - Update seed hostname to pounce.catrenelle.com - Write proper README with setup instructions Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
51 lines
998 B
Markdown
51 lines
998 B
Markdown
# Pounce
|
|
|
|
An open source, self-hosted, multi-tenant kanban board.
|
|
|
|
## Tech Stack
|
|
|
|
- **Frontend**: SvelteKit + Svelte 5 + Tailwind CSS v4
|
|
- **Backend**: SvelteKit API routes + Prisma ORM
|
|
- **Database**: PostgreSQL 16
|
|
- **Real-time**: Socket.IO
|
|
- **Auth**: Email/password with bcrypt + session cookies
|
|
- **Deployment**: Docker Compose + Portainer
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
- Node.js 22+
|
|
- PostgreSQL 16+
|
|
|
|
### Development
|
|
|
|
```sh
|
|
npm install
|
|
cp .env.example .env # edit DATABASE_URL as needed
|
|
npm run db:push # sync schema to database
|
|
npm run db:seed # seed default tenant + admin user
|
|
npm run dev
|
|
```
|
|
|
|
### Docker
|
|
|
|
```sh
|
|
docker compose up
|
|
```
|
|
|
|
The app will be available at `http://localhost:3000`.
|
|
|
|
### Default Credentials
|
|
|
|
- **Email**: admin@example.com
|
|
- **Password**: admin123
|
|
|
|
## Multi-Tenancy
|
|
|
|
Pounce supports multiple tenants on a single instance. Each tenant is identified by hostname — map additional domains via the `tenant_hostnames` table.
|
|
|
|
## License
|
|
|
|
MIT
|