ea297d09bb
* build: allow unocss to run through dev mode * build: Update unocss dependencies to latest versions Updated dependencies '@unocss/eslint-config', '@unocss/postcss', '@unocss/preset-uno', '@unocss/preset-web-fonts', '@unocss/reset', '@unocss/transformer-directives', '@unocss/transformer-variant-group' to version 0.58.6 for consistency and compatibility. * refactor: add note to readme * refactor: improve readme * refactor: update readme (again) * Update README.md Updates the UTRP description text --------- Co-authored-by: Isaiah David Rodriguez <51803892+IsaDavRod@users.noreply.github.com>
55 lines
2.2 KiB
Markdown
55 lines
2.2 KiB
Markdown
# UT Registration Plus
|
|
|
|
We've all been there. 20 tabs of Rate My Professor, Google Spreadsheet, and the UT Course Schedule open and you still don't know what classes to take.
|
|
This extension, UT Registration Plus (UTRP), tries to streamline most of the unnecessary steps and headaches of registering for classes at UT Austin.
|
|
|
|
- For each class in the UT Course Schedule site, UTRP provides a "breakdown" popup, with quick and easy links to the instructor's RateMyProfessor, Course Evaluation Survey (CES) and past syllabi.
|
|
|
|
- Shows the course description with highlighted information on prerequisites, restrictions, etc.
|
|
|
|
- Shows an aggregate and semesterly graph of the grade distributions for each course.
|
|
|
|
- Gives you the ability to add "Add Course" and view them in the extension popup, a quick list of all the courses you have saved and an easy way to copy unique numbers.
|
|
|
|
- Highlights and crosses-out what courses on the UT Course Catalog would conflict with your currently saved courses, making selecting courses that fit with your schedule so much easier.
|
|
|
|
- Display's a weekly schedule based on your saved courses.
|
|
|
|
- Give you the ability to create multiple schedules to plan for different scenarios.
|
|
|
|
- ... and much more!
|
|
|
|
## Toolchain
|
|
|
|
- React 18
|
|
- TypeScript
|
|
- Vite 5
|
|
- ESLint
|
|
- Prettier
|
|
- Storybook
|
|
- Semantic-Release
|
|
- Custom Messaging & Storage Wrappers
|
|
|
|
## Development: Getting Started
|
|
|
|
1. Clone this repo
|
|
2. This project uses `pnpm` to manage and patch dependencies. Run `pnpm install` to configure the repository for building/development
|
|
3. Using either of the methods listed below, the extension will build to the `dist/` directory.
|
|
|
|
### Development Builds
|
|
|
|
- Run `pnpm dev`
|
|
|
|
> [!NOTE]
|
|
> Injected content such as extension content on UT pages is not properly styled, and are missing class stylings. When developing for these pages, use `pnpm build -w` to build and watch for changes. This will ensure you are seeing an accurate representation of the extension.
|
|
|
|
### Production Builds
|
|
|
|
- Run `pnpm build`
|
|
|
|
## Development: Loading the Extension Manually
|
|
|
|
Open [chrome://extensions](chrome://extensions), ensure you have 'Developer Mode' enabled, and click 'Load unpacked'.
|
|
|
|
Navigate to the `dist/` folder, and click 'select' to import the extension.
|