sirAvent/AntAlmanac

A course exploration and scheduling tool for UCI Anteaters

About

AntAlmanac is a schedule planner website for classes at UC Irvine. Here are some of its features:

• Search bar to easily find classes by department (e.g COMPSCI), course code (e.g. ICS 31), and keywords (e.g. artificial intelligence)
• Calendar view to make it easier to see class times and spot conflicts
• Quick links to professor reviews, prerequisites, grade distributions, and past enrollment data.
• Notification system to tell you when a class goes from full to waitlist
• See where your classrooms are with the map view
• Clean UI (see below)

Tech Stack

Our site is a React single page application bootstrapped with create-react-app and hosted on Github Pages. We use the Material UI component library for most of our styling. The site gets its course data from the PeterPortal API, which is also maintained by ICSSC.

History

AntAlmanac was created in 2018 by a small group of students under the leadership of @the-rango.
They formed an AntAlmanac club to recruit other students and work on new features, so that the website would live on even after its makers graduated.
In 2019, @devsdevsdevs took over as AntAlmanac Project Lead and oversaw a massive rewrite of the codebase, laying the foundation for the AntAlmanac that we know and love today.
In 2020, AntAlmanac was adopted by the ICSSC Projects Committee.
ICSSC continues to provide funding, marketing, and engineering to support the growing number of users and open-source developers that make up our AntAlmanac Community. Since then, the project has continued to evolve and grow with successive generations of projects committee members!

Year	Project Lead
2018 - 2019	@the-rango (founder)
2019 - 2021	@devsdevsdevs
2021 - 2022	@ChaseC99
2022 -	@EricPedley

Contributing

We welcome open-source contributions 🤗 Here is a rough guide on how to contribute:

1. Look through the issue tracker or Kanban board to find an open issue (nobody else is assigned) or create your own that describes the problem you want to fix.
2. Fork the repository. If you're on the ICSSC Projects Committee and we've given you write access, create a branch instead of forking.
3. Get Setup to Develop Locally
4. Create a draft pull request so others can track your progress.
5. Make your changes and push them as you complete them. Change the PR from draft to open once you're done.
6. Wait for your request to get reviewed and respond to any changes until you get approval.
7. Your PR gets merged and you see your changes live on the site 🥳

We have a 30 minute contributor video tutorial available on YouTube (https://www.youtube.com/watch?v=_v91cqGzu5o).

If you ever need help, feel free to ask around on our Discord server.

Get Setup to Develop Locally

1. Clone the AntAlmanac repository or your fork

2. Navigate to the root directory and install the dependencies
   cd AntAlmanac
npm i -g pnpm (if this fails, try running it with admin privileges)
   pnpm install

3. Start the development server

   • Frontend only pnpm start:aa
   • Frontend and Backend pnpm start

4. The site should load on http://localhost:5173
   As you make changes to the React application in src, those changes will be automatically reflected on the site.

   If it isn't loading, try disabling your adblocker.

Running the Backend

The backend server isn't necessary for frontend development. By default, your frontend will send requests to dev.api.antalmanac.com, which has it's own database that is separate from production's.

If you want to run the backend locally, use pnpm start:all.

Manual Deployment

(For ICSSC Projects Committee members with write access to the repo only)

We use GitHub Pages to deploy our site. Usually deployments are done automatically through GitHub Actions, but if we need to deploy manually the instructions are below.

Make sure you are on the latest version of main before running the deploy command.

git checkout main
git pull
pnpm run deploy