feat:docs: add project setup guide and reference document
📋 Overview
This MR introduces a comprehensive PROJECT_SETUP_GUIDE.md to the wireframe-feature branch.
The document serves as a central onboarding and reference guide for developers, providing clear instructions for project setup, development workflow, and technical understanding of the VISWAM.AI codebase.
🚀 Changes
🆕 Added: PROJECT_SETUP_GUIDE.md
A detailed and structured guide covering:
🔹 Project Overview
- High-level purpose and goals of the project
🔹 Tech Stack
- TypeScript (v5.9)
- React (v19)
- Strapi (CMS backend)
- Tailwind CSS (UI styling)
🔹 Linting & Formatting
- ESLint usage
- Prettier formatting commands
🔹 Local Setup
- Step-by-step instructions to run the project locally
- Correct branch checkout process
🔹 Environment Variables
-
Documentation for:
REACT_APP_API_URL
🔹 Folder Structure
-
Clear breakdown of:
- Root directory
-
src/structure
🔹 Work Completed
-
Summary of implemented features:
- 15+ UI screens
- Strapi content-type mappings
🔹 CI/CD Pipeline
-
Overview of GitLab pipeline stages:
lint → test → build
🔹 Troubleshooting
- FAQ section for common setup and environment issues
🧪 Verification
-
✅ Verified technical versions:- Node.js v20
- TypeScript v5.9
- React v19
-
✅ Confirmed setup steps against actual codebase -
✅ Ensured correct branch (wireframe-feature) usage -
✅ Successfully pushed changes
🎯 Impact
- Simplifies developer onboarding
- Reduces setup errors and confusion
- Provides a single source of truth for project structure and workflow
- Improves team productivity and collaboration
👀 Reviewers
- @team-lead (Please assign appropriate reviewer)
🔗 MR Link
Create MR from:
wireframe-feature → main (or target branch as applicable)
✅ Checklist
-
Documentation added and structured -
Verified against codebase -
No impact on existing functionality -
Ready for review