Productionize EventSphere platform
This commit is contained in:
34
README.md
Normal file
34
README.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# EventSphere Enterprise Event Management Platform
|
||||
|
||||
Production-oriented multi-tenant event management SaaS with a Next.js admin/public frontend, NestJS API, PostgreSQL persistence, Redis-backed workers, RBAC, audit logging, payments, communications, QR check-in, CRM, forms, workflows, calendar routing, and reporting.
|
||||
|
||||
## Apps
|
||||
- `apps/web`: Next.js 14 App Router frontend.
|
||||
- `apps/api`: NestJS backend API.
|
||||
- `packages/shared`: shared TypeScript contracts.
|
||||
|
||||
## Core modules
|
||||
Events, event pages, ticket types, attendees, invitees, RSVP, registrations, QR codes, live check-in logs, calendar routing forms, bookings, email/SMS/WhatsApp via worker queues, CRM leads/deals/activities, Paystack payments/webhooks, reporting, tenant settings, integrations, users, roles, and permissions.
|
||||
|
||||
## Quick start
|
||||
```bash
|
||||
pnpm install
|
||||
pnpm --filter api prisma:generate
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
## Environment
|
||||
Copy `.env.example` to `.env`.
|
||||
|
||||
For production, copy `.env.production.example` to `.env`, replace every secret, and use `docker-compose.prod.yml`.
|
||||
|
||||
## Verification
|
||||
```bash
|
||||
pnpm run typecheck
|
||||
pnpm run lint
|
||||
pnpm run build
|
||||
docker compose -f docker-compose.prod.yml config --quiet
|
||||
```
|
||||
|
||||
## First Tenant
|
||||
Set `AUTO_BOOTSTRAP=1` with the `DEFAULT_*` values for first deployment, or visit `/setup` before any tenant exists. After the first tenant exists, public tenant creation is disabled unless `ALLOW_PUBLIC_SIGNUP=1`.
|
||||
Reference in New Issue
Block a user