Skip to content
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

chore(readme): style and accuracy when referring to anteater api #1145

Merged
merged 1 commit into from
Feb 6, 2025
Merged

chore(readme): style and accuracy when referring to anteater api #1145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ A summary of the libraries we use are listed below.

### Backend
- [tRPC](https://trpc.io) - type-safe API access layer for the AntAlmanac API.
- [Anteater API](https://docs.icssc.club/developer/anteaterapi) - API maintained by ICSSC for retrieving UCI data.
- [Anteater API](https://docs.icssc.club/docs/about/anteaterapi) - API maintained by ICSSC for retrieving UCI data.
- [Drizzle ORM](https://orm.drizzle.team/) - [high-performance](https://orm.drizzle.team/benchmarks) type-safe SQL-like access layer compatiable with all major SQL dialects.

### Tooling
Expand Down
11 changes: 5 additions & 6 deletions apps/backend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
This is the dedicated backend for [AntAlmanac](https://antalmanac.com),
which is primarily responsible for managing user data and internal information.

This is **_NOT_** for retrieving enrollment data from UCI;
[Anteater API](https://docs.icssc.club/docs/developer/anteaterapi) is a separate ICSSC project dedicated
to providing us this information.
This is **_NOT_** for retrieving course, enrollment, or similar data from UCI;
[Anteater API](https://docs.icssc.club/docs/developer/anteaterapi), a separate ICSSC project,
provides this information.

# Setup

Expand All @@ -17,9 +17,8 @@ to providing us this information.
- Populate the keys following the instructions below.
- Note that the Mapbox API key can be left blank, which will cause the app to default to OSM's tiles.

## AnteaterAPI Key
- The key is required to send course information requests to AnteaterAPI.
- It can be acquired from the [AnteaterAPI Dashboard](https://dashboard.anteaterapi.com).
## Anteater API Key
- An Anteater API key is required to send course information requests to Anteater API. You can obtain one on the [Anteater API Dashboard](https://dashboard.anteaterapi.com).

## Local Database
- Install PostgreSQL and pgAdmin.
Expand Down
Loading