StudyRoam - Find Research Stays Worldwide

This is a complete rework of the original code while keeping the UI/UX similar.

Main Changes (WIP)

• Move from SQLite to PostgreSQL hosted on Supabase ✅
• Get rid of Django backend ✅
• Switch to Next.js ✅
• Move hosting to Vercel (push to GitHub, auto-deploy to Vercel) ✅
• Keep most UI elements (TailwindCSS) ✅
• For efficiency experiment with SSR (Server Side Rendering) ✅ and SSG (Static Site Generation)
• Database is on Supabase ✅

Planned Changes

• Introduce Prisma ORM for easier DB modelling
• (optional) Introduce Apollo for GraphQL support
• (optional) Reintroduce Typescript for type safety
• (optional) Use ShadCDN for streamlined components
• Add tests
• Add analytics (e.g. Matomo, GA)
• Add Google Search Console

Development

1. Clone the repository
2. Install dependencies with pnpm install
3. Start development server with pnpm dev
4. Open http://localhost:3000 in your browser
5. For ingesting new programs: put them in ingest/extracted_programs, cd ingest, and uv run main.py

Pushing Code

Before pushing anything make sure that:

1. Pull first, if necessary rebase
2. Commit message is well formed (might move to conventional commits, checked by hooks later
3. Linting runs succesfully and does not find any errors or warnings (if it does carefully try pnpm exec biome check --write --unsafe)
4. Code is correctly formatted with no unused imports and following editorconfig
5. If you introduce a temporary change or are unsure: Use a separate feature branch!

Branching

• New Features: For now → okay on main, once live → use feature branch!
• Temporary/ experimental feature: Use feature branch
• Bugfix: For now → main, once live → hotfix branch
• Merging into main: Squash + Rebase!
• once more mature: might switch to gitflow