Files
social-media/README.md
Jonathan Bourdon df3e602015
Some checks failed
Backend CI/CD / build_and_deploy (push) Has been cancelled
Frontend CI/CD / build_and_deploy (push) Has been cancelled
feat: pivot to social media workflow app
2026-04-24 12:58:35 -04:00

89 lines
1.8 KiB
Markdown

# Socialize
Socialize is a workflow application for social media content review, revision, approval, and publication readiness.
It is not a public social network. The current product direction is a workspace-based review tool for internal teams, providers, and client approvers.
## Repository Structure
- `backend/`: ASP.NET Core `net10.0` API with FastEndpoints, EF Core, PostgreSQL, and modular bounded contexts.
- `frontend/`: Vue 3 + Vite + Vuetify + Pinia SPA.
- `docs/`: product, planning, and archived project documentation.
## Current Backend Modules
- `Identity`
- `Workspaces`
- `Clients`
- `Projects`
- `ContentItems`
- `Assets`
- `Comments`
- `Approvals`
- `Notifications`
## Local Development
### Backend
Prerequisites:
- .NET 10 SDK
- Docker
Start infrastructure:
```bash
cd backend
./scripts/start-infrastructure.sh
```
Run the API:
```bash
cd backend
dotnet run --project Socialize.Api.csproj
```
Local backend URL:
- `http://localhost:5000`
- Swagger UI: `http://localhost:5000/api`
### Frontend
Prerequisites:
- Node.js / npm
The frontend reads runtime values from:
- `frontend/.env.development`
- `frontend/.env.production`
- `frontend/src/config.js`
Run the frontend:
```bash
cd frontend
npm install
npm run dev
```
Local frontend URL:
- `http://localhost:5173`
## Validation
- Backend: `cd backend && dotnet build Socialize.Api.csproj`
- Frontend: `cd frontend && npm run build`
## Docs
- [docs/README.md](/home/jbourdon/repos/social-media/docs/README.md)
- [docs/product/vision.md](/home/jbourdon/repos/social-media/docs/product/vision.md)
- [docs/product/glossary.md](/home/jbourdon/repos/social-media/docs/product/glossary.md)
- [docs/constraints.md](/home/jbourdon/repos/social-media/docs/constraints.md)
- [AGENTS.md](/home/jbourdon/repos/social-media/AGENTS.md)