Developer Documentation
Technical documentation for platform developers
Developer Documentation
Welcome to the technical documentation for the platform. This section covers API usage, database schema, architecture, and deployment.
Documentation Sections
API Reference
REST API endpoints and authentication
Database Schema
Database structure and relationships
Architecture
System architecture and design patterns
Deployment
Deployment and infrastructure
Getting Started
Prerequisites
- Node.js 18 or higher
- PostgreSQL 15 or higher (via Supabase)
- npm or pnpm package manager
Tech Stack
- Frontend: Next.js 16, React 19, Tailwind CSS 4
- Backend: Next.js API Routes
- Database: Supabase (PostgreSQL)
- Search: Vector embeddings (768-dimensional)
- Authentication: Supabase Auth
Quick Start
- Clone the repository
- Install dependencies:
npm install - Set up environment variables
- Run database migrations
- Start the development server:
npm run dev
API Overview
The platform provides a RESTful API at /api/v1/ with endpoints for:
- User and tenant management
- Programmes and courses
- Events and registrations
- Mentorship sessions
- Resources library
- Analytics and reporting
See the API Reference for detailed endpoint documentation.
Database Structure
The platform uses a multi-tenant PostgreSQL database with:
- Row-level tenant isolation
- Vector embeddings for AI recommendations
- Partitioned analytics tables
- Full-text search capabilities
Learn more in the Database Schema section.
Need Help?
- Check the User Guide for non-technical documentation
- Review API examples in the reference docs
- Contact the development team for support