This directory contains comprehensive documentation for the Sync project.
- API Documentation - Complete API reference
- Database Schema - Database design and migrations
- Security Guidelines - Security best practices
- Deployment Guide - How to deploy Sync
- Development Setup - Local development setup
- Architecture Overview - System architecture
- Environment Setup: Copy
infra/env.exampleto.envand configure - Database: Run migrations with
npm run db:migrate - Development: Start with
npm run dev - API Key: Add your OpenAI API key to the
.envfile
IMPORTANT: You need to add your OpenAI API key to the environment configuration:
- Copy
infra/env.exampleto.envin the project root - Replace
sk-your-openai-api-key-herewith your actual OpenAI API key - The key will be used by the AI orchestrator service
/docs/
├── README.md # This file
├── api.md # API documentation
├── database.md # Database schema
├── security.md # Security guidelines
├── deployment.md # Deployment instructions
├── development.md # Development setup
├── architecture.md # System architecture
└── openapi.yaml # OpenAPI specification
- Never commit API keys or secrets to version control
- Use environment variables for all sensitive configuration
- Enable RLS (Row Level Security) in production
- All sensitive data is encrypted at rest using AES-GCM
- EU-only data processing as per requirements
- Unit tests:
npm run test - Integration tests:
npm run test:integration - E2E tests:
npm run test:e2e - Security tests:
npm run test:security
For questions or issues, please refer to the individual documentation files or create an issue in the repository.