Project Docs

Appearance

Getting Started with Family Shapes ​

This section provides everything you need to get started with the Family Shapes platform as a developer: environment setup, running the app, and links to core guidelines.

Table of Contents ​

  1. Prerequisites
  2. Installation
  3. Environment Configuration
  4. Running the Application
  5. Database Setup
  6. Next Steps

Prerequisites ​

Before you begin, ensure you have the following installed:

  • Node.js 18+ and npm
  • Supabase CLI
  • Git

Installation ​

bash
# Clone the repository
git clone <repository-url>
cd family-shapes

# Install dependencies
npm install

Environment Configuration ​

Create a .env.local file in the root directory with the following variables:

env
VITE_SUPABASE_URL=your_supabase_url
VITE_SUPABASE_ANON_KEY=your_supabase_anon_key

For database operations, create a .env file (not committed) with:

env
SUPABASE_PROJECT_REF=nhkufibfwskdpzdjwirr
SUPABASE_DB_PASSWORD=your-remote-db-password

Running the Application ​

bash
# Start the development server
npm run dev

# Build for production
npm run build

# Preview the production build
npm run preview

Database Setup ​

The application uses Supabase for the database. Follow these steps to set up the database:

bash
# Reset the local database to match migrations
make db/reset

# Check for drift between local and production
make db/check

See Database Guidelines for details: ../database/README.md.

Next Steps ​

Once you have the application running, you can:

  • Review product features: ../features/implemented-features.md
  • Learn organization features: ../features/ORGANIZATION_FEATURES.md
  • Explore the donor portal: ../features/donor-portal.md
  • Understand engineering patterns: ../development/connections.md
  • Read agent rules and workflows: /AGENTS.md