Skip to content

Update PeterPortal docs #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update PeterPortal docs #42

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f48dcfa
docs: 📚️ update peterportal frontend to nextjs
CadenLee2 Sep 26, 2025
d412c12
docs: 📚️ anteater api key for peterportal
CadenLee2 Sep 28, 2025
0bfe027
docs: 📚️ clarify purpose of anteater api key
CadenLee2 Sep 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion content/docs/contributor/peterportal/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ This document will guide you through setting up the project on your local machin

1. Inside the `api` directory, make a copy of the `.env.example` file and name it `.env`
2. Add additional variables as needed for features requiring authentication or database access.
- You may want an Anteater API key to avoid rate limit issues; see [the Anteater API docs](https://docs.icssc.club/docs/developer/anteaterapi/keys-limits) for more information.
- To test PeterPortal's search features locally, you'll need an Anteater API key with special search permissions. If you're working on a search-related issue, feel free to contact a project lead in the [Discord server](https://discord.gg/Zu8KZHERtJ) to get a search-enabled key.

</Step>
<Step>
Expand Down Expand Up @@ -88,7 +90,7 @@ To facilitate the development process, follow these steps:
pnpm run dev
```

This command starts the backend Express server and the frontend Vite dev server. Visit the link printed in the console by Vite to view the application.
This command starts the backend Express server and the frontend Next.js dev server. Visit the link printed in the console by Next.js to view the application.

Alternatively, you can run the backend and frontend separately by navigating to their respective directories and running `pnpm run dev` in separate terminal windows.

Expand Down