Skip to content

Commit c054c28

Browse files
authored
Rebrand PeterPortal docs -> AntAlmanac Planner (#48)
* chore: πŸ”§ rename appropriate instances from peterportal -> antalmanac planner * feat: ✨ antalmanac planner index page * chore: πŸ”§ remove peterportal icon * chore: πŸ”§ a capital letter * feat: ✨ redirect any peterportal links
1 parent f41b690 commit c054c28

14 files changed

Lines changed: 87 additions & 33 deletions

File tree

β€Ž.github/CODEOWNERSβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
content/docs/contributor/antalmanac @icssc/antalmanac
22

3-
content/docs/contributor/peterportal @icssc/peterportal
3+
content/docs/contributor/antalmanac-planner @icssc/peterportal
44

55
content/docs/contributor/anteaterapi @icssc/api
66
content/docs/contributor/developer @icssc/api

β€Žcomponents/logos/PeterPortal.tsxβ€Ž

Lines changed: 0 additions & 14 deletions
This file was deleted.

β€Žcomponents/logos/index.tsβ€Ž

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
import { default as AntAlmanac } from "./AntAlmanac";
2-
import { default as PeterPortal } from "./PeterPortal";
32
import { default as Zotistics } from "./Zotistics";
43

5-
const logos = { AntAlmanac, PeterPortal, Zotistics };
4+
const logos = { AntAlmanac, Zotistics };
65

76
export default logos;
251 KB
Loading
125 KB
Loading
166 KB
Loading

content/docs/contributor/peterportal/getting-started.mdx renamed to content/docs/contributor/antalmanac-planner/getting-started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ This document will guide you through setting up the project on your local machin
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.
6262
- 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.
63+
- To test AntAlmanac Planner'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.
6464

6565
</Step>
6666
<Step>
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: AntAlmanac Planner
3+
---
4+
5+
## About
6+
7+
AntAlmanac Planner is a web application designed to aid UCI students with course discovery and planning. We consolidate public data available on multiple UCI sources via [Anteater API](https://docs.icssc.club/docs/about/anteaterapi) to improve the user experience when planning course schedules. Features include:
8+
9+
- **A drag-and-drop multi-year course planner**:
10+
- Select multiple majors and minors
11+
- Import your unofficial transcript via [StudentAccess](https://www.reg.uci.edu/access/student/transcript/?seg=U) to automatically fill in your roadmap to date
12+
- View how your planned roadmap fulfills your **major**, **specialization**, **minor**, and **GE** requirements
13+
- Import any **transferred courses**, **AP exams**, and **GE/Elective credits**
14+
15+
![Roadmap](./aap-roadmap.png)
16+
17+
- **Course Search**:
18+
- Recent offerings
19+
- Grade distribution visualizations
20+
- Visual prerequisite tree
21+
- Historic Schedule of Classes data
22+
- Reviews from UCI students
23+
24+
![Course Search](./aap-coursesearch.png)
25+
26+
- **Instructor Search**:
27+
- Grade distribution visualizations
28+
- Historic Schedule of Classes data
29+
- Reviews from UCI students
30+
31+
![Instructor Search](./aap-instructorsearch.png)
32+
33+
## Technology
34+
35+
### Frontend
36+
- [React](https://react.dev/) - Library to build dynamic, component-based UIs.
37+
- [Next.js](https://nextjs.org/) - React framework with server-side rendering.
38+
- [Material UI](https://mui.com/material-ui/) - React component library that implements Google's Material Design.
39+
40+
### Backend
41+
- [Anteater API](https://github.com/icssc/anteater-api) - API maintained by ICSSC for retrieving UCI data.
42+
- [Express](https://expressjs.com/) - Minimalist backend framework for Node.js.
43+
- [tRPC](https://trpc.io/) - Library for type-safe APIs.
44+
- [PostgreSQL](https://www.postgresql.org/) - Relational database for storing user data and planners.
45+
- [Drizzle ORM](https://orm.drizzle.team/) - High-performance type-safe SQL-like access layer.
46+
47+
### Tooling
48+
- [SST](https://sst.dev/) - Infrastructure as code framework for AWS deployment.
49+
- [TypeScript](https://www.typescriptlang.org/) - JavaScript with type-checking.
50+
51+
## History
52+
AntAlmanac Planner was originally created in 2020 under the name **PeterPortal** by a team of ICSSC Projects Committee members led by @uci-mars, aiming to unify fragmented course information and long-term planning resources in one application.
53+
54+
In February 2026, PeterPortal [merged](https://docs.icssc.club/docs/about/antalmanac/merge) with [AntAlmanac](https://github.com/icssc/AntAlmanac/) into one ultimate course planning platform. Following the merger, PeterPortal was rebranded as **AntAlmanac Planner**, while the original AntAlmanac became **AntAlmanac Scheduler**.
55+
56+
| Year | Project Lead |
57+
| -------------- | ---------------------------------------------------- |
58+
| 2020 - 2021 | [@uci-mars](https://github.com/uci-mars) |
59+
| 2021 - 2022 | [@chenaaron3](https://github.com/chenaaron3) |
60+
| 2022 - 2023 | [@ethanwong16](https://github.com/ethanwong16) |
61+
| 2023 - 2024 | [@js0mmer](https://github.com/js0mmer) |
62+
| 2024 - 2025 | [@Awesome-E](https://github.com/Awesome-E) |
63+
| 2025 - Present | [@CadenLee2](https://github.com/CadenLee2) |
64+
65+
## Contributing
66+
We welcome all open-source contributions! A guide on how to contribute can be found on the Getting Started tab.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"title": "AntAlmanac Planner",
3+
"icon": "AntAlmanac",
4+
"pages": ["getting-started"]
5+
}

β€Žcontent/docs/contributor/index.mdxβ€Ž

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ Want to get started? Look no further than [here](/docs/contributor/common/gettin
1010
## Projects
1111

1212
import AntAlmanac from "@/components/logos/AntAlmanac";
13-
import PeterPortal from "@/components/logos/PeterPortal";
1413
import Zotistics from "@/components/logos/Zotistics";
1514
import {Card, Cards} from "fumadocs-ui/components/card";
1615
import { Workflow, UtensilsCrossed, Bird, CalendarRange } from "lucide-react";
@@ -24,9 +23,9 @@ import { Workflow, UtensilsCrossed, Bird, CalendarRange } from "lucide-react";
2423
Schedule Planner
2524
</Card>
2625
<Card
27-
icon={<PeterPortal />}
28-
href="/docs/contributor/peterportal"
29-
title="PeterPortal"
26+
icon={<AntAlmanac />}
27+
href="/docs/contributor/antalmanac-planner"
28+
title="AntAlmanac Planner"
3029
>
3130
Course Discovery and Planning
3231
</Card>

0 commit comments

Comments
Β (0)