Welcome to BuildTrack! This page helps you find the right documentation for your needs.
π Get the system running in 30 minutes
- Prerequisites and system requirements
- Step-by-step setup instructions
- Testing the full system
- Troubleshooting guide
π Understand the complete project status
- What has been delivered
- System architecture overview
- Implementation status
- Deployment timeline
π Work with the API
- Complete endpoint reference
- Request/response examples
- All 23 endpoints documented
- Testing with Swagger, cURL, REST Client
- Error codes and status codes
- Role-based access control
π¨ Update the frontend components
- How to migrate from Supabase to .NET API
- AuthContext replacement code
- Component pattern examples
- 5 complete page examples (Login, Dashboard, Projects, Orders, Settings)
- Testing strategies
- Migration checklist
π Understand the complete migration process
- 13-phase migration plan
- Common replacement patterns
- Real-time features conversion
- Data migration strategies
- Testing checklist
- Git commit strategy
ποΈ Learn about backend architecture
- Project structure
- Database design
- Service layer architecture
- Running locally
- Production deployment guide
Start with these in order:
-
PROJECT_STATUS.md (5 mins)
- Understand what's been done
- See high-level architecture
- Get timeline expectations
-
QUICKSTART.md (30 mins)
- Set up backend (15 mins)
- Set up frontend (5 mins)
- Test the system (5 mins)
- Troubleshoot any issues
-
API_DOCUMENTATION.md (Browse as needed)
- Reference for all endpoints
- Test with Swagger or REST Client
- Understand response formats
- backend/README.md - Architecture and setup
- API_DOCUMENTATION.md - API reference
- database-scripts/CreateDatabase.sql - Database schema
- FRONTEND_INTEGRATION_GUIDE.md - Component migration
- API_DOCUMENTATION.md - API endpoints to call
- src/services/api.ts - API client service (ready to use)
- backend/README.md - Production deployment guide
- PROJECT_STATUS.md - Deployment timeline
- MIGRATION_GUIDE.md - Deployment considerations
- PROJECT_STATUS.md - What's been delivered and timeline
- QUICKSTART.md - How long setup takes
- MIGRATION_GUIDE.md - Detailed phase breakdown
Root Directory:
βββ QUICKSTART.md β Start here! (30 mins)
βββ PROJECT_STATUS.md β Overview & summary
βββ API_DOCUMENTATION.md β All endpoints (reference)
βββ FRONTEND_INTEGRATION_GUIDE.md β Component migration
βββ MIGRATION_GUIDE.md β Comprehensive migration
βββ README.md β Original project README
βββ SYSTEM_MASTER_PROMPT.md β System context/prompt
Backend:
βββ backend/BuildTrack.API/
β βββ README.md β Backend architecture
β βββ Program.cs β Startup configuration
β βββ appsettings.json β Configuration
β βββ Controllers/ β API endpoints
β βββ Services/ β Business logic
β βββ Models/Entities.cs β Database entities
β βββ Data/ApplicationDbContext.cs β Database context
β βββ DTOs/AllDtos.cs β Data transfer objects
Frontend:
βββ src/
β βββ services/api.ts β API client (NEW - ready to use)
β βββ contexts/AuthContext.tsx β Auth context (update needed)
β βββ pages/ β Pages to update
β βββ components/ β Components to update
Database:
βββ database-scripts/
βββ CreateDatabase.sql β Database schema
Setting up the development environment β QUICKSTART.md - Step 1
Understanding the system architecture β PROJECT_STATUS.md - System Architecture
Learning how authentication works β PROJECT_STATUS.md - Authentication Flow
Testing API endpoints β API_DOCUMENTATION.md - Testing with Swagger/cURL
Migrating a frontend component β FRONTEND_INTEGRATION_GUIDE.md - Component Pattern Updates
Handling errors in frontend β FRONTEND_INTEGRATION_GUIDE.md - Common Issues
Database schema reference β PROJECT_STATUS.md - Database Entities
All API endpoints list β PROJECT_STATUS.md - API Endpoints or API_DOCUMENTATION.md
Deployment instructions β backend/README.md - Production Deployment or PROJECT_STATUS.md - Deployment Timeline
- Backend API: https://localhost:7069 (development)
- Swagger UI: http://localhost:7069/swagger
- Frontend: http://localhost:5173 (development)
Email: admin@buildtrack.local
Password: Admin123!@#
- Frontend: React 18, TypeScript, Vite, Shadcn UI
- Backend: ASP.NET Core 8.0, C#
- Database: SQL Server Express
- Authentication: JWT (JSON Web Tokens)
- API: RESTful with 23 endpoints
- Frontend API Client:
src/services/api.ts(250+ lines) - Backend Startup:
backend/BuildTrack.API/Program.cs(130+ lines) - Database Context:
backend/BuildTrack.API/Data/ApplicationDbContext.cs(400+ lines) - Entity Models:
backend/BuildTrack.API/Models/Entities.cs(500+ lines)
| Task | Time | Difficulty |
|---|---|---|
| Read this index | 5 mins | Easy |
| Read PROJECT_STATUS | 5 mins | Easy |
| Backend setup (QUICKSTART) | 15 mins | Easy |
| Frontend setup (QUICKSTART) | 5 mins | Easy |
| Test full system | 5 mins | Easy |
| Review API_DOCUMENTATION | 20 mins | Easy |
| Migrate one page | 15-30 mins | Medium |
| Complete frontend migration (16 pages) | 1-2 hours | Medium |
| Full testing | 1-2 hours | Medium |
| Production deployment | Varies | Hard |
Total time to run locally: ~30 minutes Total time to integrate frontend: 1-2 hours Total time ready for deployment: 1-2 days
Before starting, verify you have:
Prerequisites Installed
- .NET 8.0 SDK
- SQL Server Express
- Node.js 18+
- VS Code or IDE
Local Environment
- Backend code in
backend/BuildTrack.API/ - Frontend code in
src/ - API client in
src/services/api.ts - Database script in
database-scripts/CreateDatabase.sql
Documentation Available
- QUICKSTART.md
- API_DOCUMENTATION.md
- FRONTEND_INTEGRATION_GUIDE.md
- PROJECT_STATUS.md
- backend/README.md
- Quick Start Issues β See QUICKSTART.md Troubleshooting
- API Issues β See API_DOCUMENTATION.md Error Responses
- Frontend Issues β See FRONTEND_INTEGRATION_GUIDE.md Common Issues
- Migration Issues β See MIGRATION_GUIDE.md Troubleshooting
- Backend Issues β See backend/README.md Troubleshooting
β±οΈ 30 minutes
- QUICKSTART.md - Follow Steps 1-3
- Test login works
- Done! π
β±οΈ 1-2 hours
- PROJECT_STATUS.md - 5 mins
- QUICKSTART.md - 30 mins
- API_DOCUMENTATION.md - 20 mins
- Test endpoints with Swagger - 15 mins
- Review code in
backend/- 20 mins - Done! π
β±οΈ 3-4 hours
- PROJECT_STATUS.md - 10 mins
- QUICKSTART.md - 30 mins
- backend/README.md - 30 mins
- API_DOCUMENTATION.md - 30 mins
- FRONTEND_INTEGRATION_GUIDE.md - 30 mins
- MIGRATION_GUIDE.md - 30 mins
- Review all code files - 1 hour
- Test all endpoints - 30 mins
- Done! π
β±οΈ 1-2 hours
- QUICK START.md - Get system running - 30 mins
- FRONTEND_INTEGRATION_GUIDE.md - Understand patterns - 20 mins
- API_DOCUMENTATION.md - Reference endpoints - 20 mins
- Update components one by one - 30-60 mins
- Test end-to-end - 30 mins
- Done! π
- Check if there's a troubleshooting section in the relevant doc
- Search for keywords in the docs using Ctrl+F
- Review the "What's Been Done" section in PROJECT_STATUS.md
- Read entire QUICKSTART.md carefully
- Check "Common Issues" in QUICKSTART.md
- Verify all prerequisites are installed
- Check error messages in terminal output
- Review endpoint in API_DOCUMENTATION.md
- Test in Swagger UI: http://localhost:7069/swagger
- Check request/response format matches documentation
- Verify JWT token is valid (not expired)
- Check FRONTEND_INTEGRATION_GUIDE.md "Common Issues"
- Open browser console (F12) for JavaScript errors
- Verify .env has correct API_BASE_URL
- Check backend is running
β Complete Backend - ASP.NET Core 8.0 with 23 API endpoints β Database Schema - SQL Server with 20 entities and relationships β Authentication - JWT with refresh tokens β Frontend API Client - Ready to use in components β Documentation - 5 comprehensive guides + this index β Examples - Code samples for 5 complete pages β Testing Guides - Unit, integration, and E2E examples β Deployment Guide - Production setup instructions
Option 1: Just run it (30 mins) β Go to QUICKSTART.md
Option 2: Understand first (1 hour) β Go to PROJECT_STATUS.md, then QUICKSTART.md
Option 3: Deep dive (3-4 hours) β Follow "Path 3: Complete Deep Dive" above
Option 4: Update frontend (1-2 hours) β Follow "Path 4: Frontend Migration" above
All documentation is current as of the latest code update.
| Document | Last Updated | Coverage |
|---|---|---|
| QUICKSTART.md | Latest | 100% |
| PROJECT_STATUS.md | Latest | 100% |
| API_DOCUMENTATION.md | Latest | 23/23 endpoints |
| FRONTEND_INTEGRATION_GUIDE.md | Latest | 5 example pages |
| MIGRATION_GUIDE.md | Latest | 13 phases |
| backend/README.md | Latest | 100% |
Questions? Start with QUICKSTART.md and get the system running! Everything will become clearer once you see it working. π