2.0 KiB
2.0 KiB
Project Folder Structure
This document outlines the recommended GitHub-ready layout for your CulturalSync AI project.
/
├── client/ # Frontend (React + Tailwind)
│ ├── public/
│ └── src/
│ ├── assets/
│ ├── components/
│ ├── hooks/
│ ├── pages/
│ ├── stores/
│ ├── styles/
│ └── utils/
│ ├── package.json
│ ├── tailwind.config.js
│ └── tsconfig.json
├── server/ # Backend (Node.js + Express + MongoDB)
│ ├── models/ # Mongoose schemas
│ ├── routes/ # Express routers (users, orgs, workflows, etc.)
│ ├── middleware/ # Auth, error handlers, RBAC checks
│ ├── utils/ # Helpers (email, logger, config)
│ ├── controllers/ # Business logic for each route
│ ├── services/ # External integrations (n8n, X API, AI, etc.)
│ ├── config/ # Database, environment variables, constants
│ ├── index.js # App entry point
│ ├── package.json
│ └── .env.example
├── scripts/
│ └── seed.js # Seed sample MongoDB data (orgs, users, workflows, logs)
├── Dockerfile # Multi-stage build for client & server
├── docker-compose.yml # (Optional) local dev orchestration
├── .gitignore
├── README.md # Project overview & setup instructions
└── FOLDER_STRUCTURE.md # (This file)
Next steps:
- Move your existing frontend code into
client/src/. - Move backend code into
server/, splitting models, routes, middleware, etc. - Update root-level Dockerfile/docker-compose.yml to reference
clientandserver. - Drop
scripts/seed.jsin place for sample data.
Commit this structure before adding custom modules (n8n embed, AI prompts, compliance checks).