|
1 | | -# Degree Audit Plus |
2 | | - |
3 | | -Build status badge once i get that setup |
4 | | - |
5 | | -An extension to make making 4-year plans at UT austin easier |
6 | | - |
7 | | -## Overview |
8 | | -- problem: making 4 year plans is hard |
9 | | -- solution: make it easier! |
10 | | -- target audience: people who go to UT who intend to graduate |
11 | | -- screenshots: soon |
12 | | - |
13 | | -## Getting Started |
14 | | - |
15 | | -### Install |
16 | | -- install bun [here](https://bun.sh) |
17 | | -- clone the repo: `git clone https://github.com/Longhorn-Developers/Degree-Audit-Plus` |
18 | | -- go into the appropriate directory: `cd Degree-Audit-Plus` |
19 | | -- install deps: `bun install` |
20 | | - |
21 | | -### Use |
22 | | -- for end users: install from chrome store |
23 | | -- devs: use `bun dev` to start the extension, which puts the output in `.output`, but it'll autoload into a new chrome window |
24 | | - |
25 | | -### Other stuff |
26 | | -?? |
27 | | - |
28 | | -## Architecture |
29 | | -- chrome extension, wxt, tailwind css, idk what else |
30 | | -- key components: 4 year plan maker, degree audit runner, this needs more planning |
31 | | -- design principles: be aesthetically pleasing |
32 | | - |
33 | | -## Workflow |
34 | | -- use conventional commits |
35 | | -- name branches as `your-name-or-github/feat-or-fix/DESCRIPTION` |
36 | | -- PR process: idk make one, describe the feature and such |
37 | | -- contribution guidelines: don't be mean |
38 | | -- code of conduct: don't be mean |
39 | | - |
40 | | -## Tooling |
41 | | -- ESLint — linting |
42 | | -- Prettier — formatting |
43 | | -- Vitest — unit testing |
44 | | -- Commitlint — commit message checking |
45 | | -- Husky — git hooks |
46 | | -- GitHub Actions — automated workflows |
47 | | - |
48 | | -## Available Scripts |
49 | | -- build the extension for development (chrome): `bun dev` |
50 | | -- ^^ (firefox): `bun dev:firefox` |
51 | | -- make an actual build of the extension (chrome): `bun build` |
52 | | -- ^^ (firefox): `bun build:firefox` |
53 | | -- make a distribution zip (chrome): `bun zip` |
54 | | -- ^^ (firefox) (do you see the pattern yet?): `bun zip:firefox` |
55 | | -- run testing scripts: `bun run test` |
56 | | -- make ts types?: `bun postinstall` |
57 | | - |
58 | | -## Structure |
59 | | -see wxt's project structure [here](https://wxt.dev/guide/essentials/project-structure.html) |
60 | | - |
61 | | -## Deployment |
62 | | -- tbd |
| 1 | + |
| 2 | +# UT Degree Audit Plus ✨ |
| 3 | + |
| 4 | +An unofficial Chrome extension designed to enhance and modernize the degree planning experience for students at the University of Texas at Austin. |
| 5 | + |
| 6 | +## The Problem |
| 7 | + |
| 8 | +The official degree audit system is powerful but can be difficult to read, non-interactive, and challenging for long-term planning.ee Audit Plus aims to solve this by transforming the static audit page into a dynamic, interactive, and user-friendly dashboard through an extension. |
| 9 | + |
| 10 | +## Key Features (to be implemented) |
| 11 | + |
| 12 | + * ** Interactive Dashboard:** Replaces the default audit layout with a clean, modern interface that visualizes your degree progress. |
| 13 | + * ** Dynamic Checklists:** See exactly which requirements you've fulfilled and what's left to complete for your majors, minors, and certificates. |
| 14 | + * ** What-If Scenarios:** Experiment with adding a minor or changing majors to instantly see how it would affect your graduation requirements. |
| 15 | + * ** Prerequisite Visualization:** A clear, graphical view of course dependencies so you never register for a class out of sequence. |
| 16 | + * ** Four-Year Planner:** Drag and drop courses into a semester-by-semester plan to build a clear roadmap to graduation. |
| 17 | + * ** Secure & Private:** The extension runs entirely in your local browser. Your academic data is never sent to, stored on, or seen by any external server. |
| 18 | + |
| 19 | +*(Add a screenshot or a GIF of your extension in action here\!)* |
| 20 | + |
| 21 | +## Tech Stack |
| 22 | + |
| 23 | + * **Frontend:** React, TypeScript |
| 24 | + * **Styling:** Tailwind CSS |
| 25 | + * **State Management:** Redux Toolkit |
| 26 | + * **Backend & Data:** Supabase (for storing user-created plans) |
| 27 | + * **Platform:** Chrome Extension API (Manifest V3) |
| 28 | + * **Build Tools:** WXT, Vite, Node.js |
| 29 | + |
| 30 | +## Installation |
| 31 | + |
| 32 | +### For Students (Recommended) |
| 33 | + |
| 34 | +1. Install the extension from the [**Chrome Web Store**](https://www.google.com/search?q=https://chrome.google.com/webstore/detail/your-extension-id) (Link coming soon\!). |
| 35 | +2. Navigate to the UT Degree Audit page, run an audit, and the extension will automatically activate. |
| 36 | + |
| 37 | +### For Developers |
| 38 | + |
| 39 | +To get the development environment running locally: |
| 40 | + |
| 41 | +1. **Clone the repository:** |
| 42 | + |
| 43 | + ```bash |
| 44 | + git clone https://github.com/your-username/ut-degree-audit-plus.git |
| 45 | + cd ut-degree-audit-plus |
| 46 | + ``` |
| 47 | + |
| 48 | +2. **Install dependencies:** |
| 49 | + |
| 50 | + ```bash |
| 51 | + npm install |
| 52 | + ``` |
| 53 | + |
| 54 | +3. **Run the development build:** |
| 55 | + This command will watch for file changes and rebuild the extension automatically. |
| 56 | + |
| 57 | + ```bash |
| 58 | + npm run dev |
| 59 | + ``` |
| 60 | + |
| 61 | +4. **Load the extension in Chrome:** |
| 62 | + |
| 63 | + * Open Chrome and navigate to `chrome://extensions`. |
| 64 | + * Enable **"Developer mode"** in the top right corner. |
| 65 | + * Click on **"Load unpacked"**. |
| 66 | + * Select the `.output/chrome-mv3` folder that was created in the project directory. |
| 67 | + |
| 68 | +5. **Development Tools:** |
| 69 | + |
| 70 | + The project uses WXT as the extension framework, which provides: |
| 71 | + * Hot Module Replacement (HMR) for fast development |
| 72 | + * TypeScript support out of the box |
| 73 | + * Automatic manifest generation |
| 74 | + |
| 75 | + **Available Scripts:** |
| 76 | + * `npm run dev` - Start development mode with hot reload |
| 77 | + * `npm run dev:firefox` - Start development mode for Firefox |
| 78 | + * `npm run build` - Build production-ready extension for Chrome |
| 79 | + * `npm run build:firefox` - Build production-ready extension for Firefox |
| 80 | + * `npm run compile` - Type-check without building |
| 81 | + |
| 82 | + **Styling with Tailwind CSS:** |
| 83 | + * Tailwind CSS is configured and ready to use |
| 84 | + * Use utility classes directly in your React components |
| 85 | + * Configuration file: `tailwind.config.js` |
| 86 | + * Main stylesheet: `entrypoints/popup/style.css` |
| 87 | + |
| 88 | +## Contributing |
| 89 | + |
| 90 | +Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. |
| 91 | + |
| 92 | +If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". |
| 93 | + |
| 94 | +1. Fork the Project |
| 95 | +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) |
| 96 | +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) |
| 97 | +4. Push to the Branch (`git push origin feature/AmazingFeature`) |
| 98 | +5. Open a Pull Request |
| 99 | + |
| 100 | +## The Team |
| 101 | + |
| 102 | +This project is led and maintained by a dedicated group of UT Austin students. |
| 103 | + |
| 104 | +## License |
| 105 | + |
| 106 | +This project is distributed under the MIT License. See `LICENSE.txt` for more information. |
| 107 | + |
| 108 | +----- |
| 109 | + |
| 110 | +### ⚖️ Disclaimer |
| 111 | + |
| 112 | +UT Degree Audit Plus is an independent, student-led project and is **not** an official application of, or affiliated with, The University of Texas at Austin. The tool is provided as-is, without warranty. Always confirm your academic plan with your academic advisor. |
0 commit comments