This document provides instructions for AI coding agents to effectively contribute to the Code for Life workspace.
Sign in to like and favorite skills
This document provides instructions for AI coding agents to effectively contribute to the Code for Life workspace.
This is a monorepo containing multiple services for the Code for Life platform. The project is divided into three main parts:
frontend/backend/pipenvlegacy/The entire workspace is managed as a collection of Git submodules. The main entry point for development in VS Code is the
codeforlife.code-workspaceAll development tasks are orchestrated through a set of powerful shell scripts located in
/workspace/frontend/scripts/workspace/backend/scripts/workspace/frontendThe frontend is a modern TypeScript/React setup using Vite and Vitest.
Setup: To install all dependencies, navigate to a service's directory (e.g.,
/workspace/frontend/portal/workspace/frontend/scripts setup
Running Checks: To run all quality checks (linting, formatting, type checking, and tests), use the
check/workspace/frontend/scripts check
Running the Dev Server: To start the development server for a specific service:
/workspace/frontend/scripts run:dev
Running Tests: To run tests for a service:
/workspace/frontend/scripts test
/workspace/backendThe backend consists of several Django services.
Setup: To set up the Python environment and install dependencies for a service, navigate to its directory (e.g.,
/workspace/backend/portal/workspace/backend/scripts setup
Running Checks: To run all quality checks (imports, formatting, type checking, linting, migrations, and tests), use the
check/workspace/backend/scripts check
Running the Django Server: To start the local Django development server:
/workspace/backend/scripts run:django
Running Tests: To run tests for a service:
/workspace/backend/scripts test
Database Migrations: The backend uses Django migrations. When you change a model, you'll need to create a migration. The
checkyarnvitepipenvpytest/workspace/frontend/scripts/workspace/backend/scripts/workspace/frontend/package.jsontsconfig.base.jsonblackpylintpytest/workspace/backend/pyproject.toml/workspace/frontend/portal/workspace/backend/ssocodeforlife-workspaceBy following these guidelines, you will be able to navigate the codebase and contribute effectively.