From f48dcfa1da591c50edb5027b276efa0c5b8c7979 Mon Sep 17 00:00:00 2001 From: Caden Lee Date: Fri, 26 Sep 2025 10:37:43 -0700 Subject: [PATCH 1/3] =?UTF-8?q?docs:=20=F0=9F=93=9A=EF=B8=8F=20update=20pe?= =?UTF-8?q?terportal=20frontend=20to=20nextjs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/contributor/peterportal/getting-started.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/contributor/peterportal/getting-started.mdx b/content/docs/contributor/peterportal/getting-started.mdx index 8d64472..a154ea3 100644 --- a/content/docs/contributor/peterportal/getting-started.mdx +++ b/content/docs/contributor/peterportal/getting-started.mdx @@ -88,7 +88,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. From d412c122a98c1d4e586b693f440e1f263a3e172f Mon Sep 17 00:00:00 2001 From: Caden Lee Date: Sat, 27 Sep 2025 20:12:12 -0700 Subject: [PATCH 2/3] =?UTF-8?q?docs:=20=F0=9F=93=9A=EF=B8=8F=20anteater=20?= =?UTF-8?q?api=20key=20for=20peterportal?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/contributor/peterportal/getting-started.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/docs/contributor/peterportal/getting-started.mdx b/content/docs/contributor/peterportal/getting-started.mdx index a154ea3..0619ad1 100644 --- a/content/docs/contributor/peterportal/getting-started.mdx +++ b/content/docs/contributor/peterportal/getting-started.mdx @@ -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; 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. From 0bfe027484f3b62aa33e46f5fedacc20cb64e18f Mon Sep 17 00:00:00 2001 From: Caden Lee Date: Sun, 28 Sep 2025 10:40:42 -0700 Subject: [PATCH 3/3] =?UTF-8?q?docs:=20=F0=9F=93=9A=EF=B8=8F=20clarify=20p?= =?UTF-8?q?urpose=20of=20anteater=20api=20key?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/contributor/peterportal/getting-started.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/contributor/peterportal/getting-started.mdx b/content/docs/contributor/peterportal/getting-started.mdx index 0619ad1..7846ab7 100644 --- a/content/docs/contributor/peterportal/getting-started.mdx +++ b/content/docs/contributor/peterportal/getting-started.mdx @@ -59,7 +59,7 @@ 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; see [the Anteater API docs](https://docs.icssc.club/docs/developer/anteaterapi/keys-limits) for more information. + - 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.