Skip to content
CoogCasa Docs

Quick Start

Quick Start

Section titled “Quick Start”

Get CoogCasa running locally for development.

Prerequisites

Section titled “Prerequisites”
  • Node.js 18+
  • npm or pnpm
  • Git
  • Cloudflare account (for Workers development)

Clone the Repository

Section titled “Clone the Repository”
Terminal window
git clone https://github.com/KevinTrinh1227/CoogCasa.git
cd CoogCasa

Project Structure

Section titled “Project Structure”
CoogCasa/
├── web/                 # Main website (Astro + React)
├── api/
│   ├── router/          # API router worker
│   └── scholarships-backend/  # Scholarships API
├── bots/                # Discord bots
├── docs/                # This documentation
└── monitor-proxy/       # Status monitoring

Website Development

Section titled “Website Development”

Install Dependencies

Section titled “Install Dependencies”
Terminal window
cd web
npm install

Environment Setup

Section titled “Environment Setup”

Create web/.env:

PUBLIC_SUPABASE_URL=https://phjrisqqhaqznpyeeuom.supabase.co
PUBLIC_SUPABASE_ANON_KEY=your-anon-key
PUBLIC_SPORTS_API_URL=https://coog-sports-backend.coog-planner.workers.dev
PUBLIC_SCHOLARSHIPS_API_URL=https://coog-scholarships-backend.coog-planner.workers.dev

Start Development Server

Section titled “Start Development Server”
Terminal window
npm run dev

The site will be available at http://localhost:4321.

Build for Production

Section titled “Build for Production”
Terminal window
npm run build
npm run preview  # Preview the production build

API Development

Section titled “API Development”

Sports Backend

Section titled “Sports Backend”

The sports backend is in a separate repository:

Terminal window
cd /path/to/coog-sports-backend
npm install
npm run dev

Scholarships Backend

Section titled “Scholarships Backend”
Terminal window
cd api/scholarships-backend
npm install
npm run dev

API Router

Section titled “API Router”
Terminal window
cd api/router
npm install
npm run dev

Testing

Section titled “Testing”

Run Tests

Section titled “Run Tests”
Terminal window
npm run test

Run Linting

Section titled “Run Linting”
Terminal window
npm run lint

Deployment

Section titled “Deployment”

Website (Automatic)

Section titled “Website (Automatic)”

Pushing to main branch automatically deploys to Cloudflare Pages.

Workers (Manual)

Section titled “Workers (Manual)”
Terminal window
cd api/router
npm run deploy

Common Commands

Section titled “Common Commands”
CommandDescription
npm run devStart development server
npm run buildBuild for production
npm run previewPreview production build
npm run deployDeploy to Cloudflare
npm run lintRun linting
npm run testRun tests

Troubleshooting

Section titled “Troubleshooting”

Port Already in Use

Section titled “Port Already in Use”

If port 4321 is in use, Astro will try the next available port (4322, 4323, etc.).

Supabase Connection Issues

Section titled “Supabase Connection Issues”

Ensure your Supabase project is active and the anon key is correct. Check the Supabase dashboard for any service disruptions.

Build Errors

Section titled “Build Errors”
  1. Clear the .astro cache: rm -rf .astro
  2. Delete node_modules: rm -rf node_modules
  3. Reinstall: npm install
  4. Try again: npm run build

Next Steps

Section titled “Next Steps”