Skip to content

Commit f41b690

Browse files
authored
Update PeterPortal docs to mention Next.js and Anteater API key search permissions (#42)
* docs: 📚️ update peterportal frontend to nextjs * docs: 📚️ anteater api key for peterportal * docs: 📚️ clarify purpose of anteater api key
1 parent 73c1876 commit f41b690

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

content/docs/contributor/peterportal/getting-started.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ This document will guide you through setting up the project on your local machin
5959

6060
1. Inside the `api` directory, make a copy of the `.env.example` file and name it `.env`
6161
2. Add additional variables as needed for features requiring authentication or database access.
62+
- 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.
63+
- 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.
6264

6365
</Step>
6466
<Step>
@@ -88,7 +90,7 @@ To facilitate the development process, follow these steps:
8890
pnpm run dev
8991
```
9092

91-
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.
93+
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.
9294

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

0 commit comments

Comments
 (0)