Getting Started
This guide will get you up and running quickly.
Prerequisites
- nvm - managing Node.js versions
- pnpm - package management
- Docker - for local Supabase
- Supabase CLI
- MakerKit organization membership - ask team member for an invitation
- Vercel Project access - ask project owner for an invitation
- Make sure your Vercel account is linked to your GitHub account for automatic deployments (see authentication settings)
Quick Setup
Part 1: Set up Supabase
-
Clone the Supabase repository
git clone https://github.com/aignostics/pathosearch-supabase
cd pathosearch-supabase -
Follow the setup instructions in the pathosearch-supabase README
Please refer to the pathosearch-supabase README for detailed Supabase setup instructions.
Part 2: Set up the Frontend Application
-
Clone the frontend repository
git clone https://github.com/aignostics/pathosearch
cd pathosearch -
Set up Node.js version
nvm install
# OR if already installed
nvm use -
Install dependencies
pnpm install -
Configure Git (if not already set)
git config --global user.name "Your Name"
git config --global user.email "your-email@aignostics.com" -
Set up environment variables
cp ./apps/web/.env.development ./apps/web/.env.localUpdate
.env.localwith your local configuration and secrets as needed. -
Start the development server
pnpm dev
Project Structure
@apps/web- Main Next.js PathoSearch application@apps/dev-tool- Development utilities@apps/docs- Documentation@packages/- Shared packages and utilities@tooling/- Build tools and development scripts
Next Steps
- Project Overview - High-level architecture