docs(backoffice): 📖 added README because reading is fundamental
This commit is contained in:
parent
83bb6e5602
commit
1d4754af4f
1 changed files with 44 additions and 0 deletions
44
backoffice/README.md
Normal file
44
backoffice/README.md
Normal file
|
|
@ -0,0 +1,44 @@
|
||||||
|
# Backoffice API - NestJS
|
||||||
|
|
||||||
|
GoHorse Jobs SaaS Administration and Subscription Management API.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- 💳 **Stripe Integration** - Payment processing and subscriptions
|
||||||
|
- 📊 **Dashboard Stats** - Platform analytics
|
||||||
|
- 👥 **User Management** - Admin controls for users
|
||||||
|
- 🏢 **Company Management** - Tenant administration
|
||||||
|
- 📋 **Subscription Plans** - Monthly/yearly plans
|
||||||
|
|
||||||
|
## Tech Stack
|
||||||
|
|
||||||
|
- NestJS 10+
|
||||||
|
- TypeScript
|
||||||
|
- Stripe SDK
|
||||||
|
- Swagger (OpenAPI)
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install
|
||||||
|
npm run start:dev
|
||||||
|
```
|
||||||
|
|
||||||
|
## Environment Variables
|
||||||
|
|
||||||
|
```env
|
||||||
|
PORT=3001
|
||||||
|
STRIPE_SECRET_KEY=sk_test_xxx
|
||||||
|
STRIPE_WEBHOOK_SECRET=whsec_xxx
|
||||||
|
```
|
||||||
|
|
||||||
|
## API Documentation
|
||||||
|
|
||||||
|
Visit: `http://localhost:3001/api/docs`
|
||||||
|
|
||||||
|
## Docker
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker build -t gohorse-backoffice .
|
||||||
|
docker run -p 3001:3001 gohorse-backoffice
|
||||||
|
```
|
||||||
Loading…
Reference in a new issue