Skip to main content

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.

YouEyeSea is open source and welcomes contributions of all kinds — bug fixes, new features, documentation improvements, and data tooling. This page explains the license, the contribution workflow, and where to find the other guides you’ll need to get started.

​
License

YouEyeSea is licensed under AGPL-3.0. Key implications for contributors:
  • You retain copyright over the code you write and contribute.
  • Derivative works must remain open source — any modified version you distribute or run as a network service must be released under the same AGPL-3.0 terms.
  • See LICENSE.txt in the repository root for the full license text.

​
Contribution workflow

1

Create or find an issue

Before writing code for a new feature, open an issue in the GitHub repository to describe what you want to build. This avoids duplicated effort and lets maintainers give early feedback. Bug reports can go straight to a PR, but an issue first is still welcome.
2

Fork the repository

Fork alexjohntomy/you-eye-sea to your own GitHub account, then clone your fork locally:
git clone https://github.com/YOUR_USERNAME/you-eye-sea
cd you-eye-sea
npm install
3

Create a branch

Create a branch named for the fix or feature you’re working on:
git checkout -b my-feature-name
4

Commit your changes

Make your changes, then commit with a clear message describing what changed and why:
git add .
git commit -m "Add semester comparison chart to course detail page"
5

Open a pull request

Push your branch to your fork and open a pull request against the main branch of alexjohntomy/you-eye-sea. Describe your changes in the PR body and reference the related issue if one exists.

​
Code style

YouEyeSea uses Prettier for formatting and ESLint for linting. The Prettier config at .prettierrc enforces:
  • Double quotes for strings
  • Trailing commas where valid in ES5
  • Semicolons
  • Arrow function parentheses always included
  • Tailwind CSS class sorting via prettier-plugin-tailwindcss
Run the linter before opening a PR: 
npm run lint
Prettier runs automatically on save if you use the Prettier VS Code extension, or you can format manually with npx prettier --write ..

​
Next steps

Database setup

Set up a local PostgreSQL database and apply Prisma migrations.

Data ingestion

Load UIC grade distribution CSVs with the seed script.

Development workflow

Run the local dev server and understand the project structure.

GitHub repository

Browse the source code, issues, and pull requests.

Build docs developers (and LLMs) love

Get started for freeTalk to us