YouEyeSea uses PostgreSQL as its database and Prisma as the ORM. Before you can run the app or seed grade data, you need a running Postgres instance and the correct environment variables in place.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/alexjohntomy/you-eye-sea/llms.txt
Use this file to discover all available pages before exploring further.
Prerequisites
- PostgreSQL installed and running locally (version 14 or later recommended)
- Node.js 18 or later with
npm - The repository cloned and dependencies installed (
npm install)
Set the DATABASE_URL
Create a.env file in the project root (or export the variable in your shell) with your Postgres connection string:
prisma.config.ts reads DATABASE_URL at runtime using dotenv/config, so a .env file in the project root is the simplest way to set it. Add .env to your .gitignore to avoid committing credentials.Generate the Prisma client
Runningnpm install automatically triggers prisma generate via the postinstall script. If you ever need to regenerate the client manually — for example after editing prisma/schema.prisma — run:
src/generated/prisma/.
Apply migrations
Theprisma/migrations/ directory contains the migration history for the project. To apply all pending migrations to your database, run:
db push, which syncs the schema without creating migration files:
db push is faster for rapid iteration on schema changes, but does not produce a migration history. Use migrate deploy when you want your local environment to match the committed migration state exactly.
Prisma Accelerate in production
The app uses@prisma/extension-accelerate for connection pooling when deployed to Vercel. Accelerate is applied in lib/prisma.ts:
Locally,
DATABASE_URL is a standard Postgres connection string and Accelerate falls back to a direct connection. In production on Vercel, set DATABASE_URL to a Prisma Accelerate connection string (beginning with prisma://) to enable pooling. See the Prisma Accelerate docs for setup instructions.Verify the connection
After applying migrations, you can open Prisma Studio to confirm the database schema looks correct:http://localhost:5555 where you can inspect tables and rows.
Next steps
With your database ready, load grade data using the seed script:Data ingestion
Learn how to download UIC CSVs and populate your database with the seed script.
