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

Update README.md #52

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #52

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
37 changes: 34 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,57 @@

A web app to help students at the University of Florida plan classes for the semester.

Swamp Scheduler currently allows students to explore UF's schedule of courses, make course selections, and generate schedules that fit their needs.

## Table of Contents

- [Usage](#Usage)
- [App](#app)
- [Usage](#usage)
- [Maintainers](#maintainers)
- [Documentation](#documentation)
- [License](#license)

## App

[Link](https://osc.rconde.xyz/)

Course Search:
- You can select a term (ie. Fall 2023) from the dropdown on the top right.
- At the top left there is a search bar for courses
- Using the drop-down, select whether you would like to search by course code or name
- Once you search, courses matching that query will appear in the left bar. There is a course code, name, description, and credit load.
- Underneath that you will find available sections. Each section contains information about the meeting times, instructor(s), and periods.
- If you click on a class period, a link will take you to the UF campus map highlighting the class location

Schedule:
- When you select a course, it appears in your courses in the center pane
- If you would like to add more courses, click on 'Add Course'
- As you add more courses, schedule options are generated in the right pane
- You can select a limit for how many shedules to generate

## Usage

To run the development server locally:
- `cd app`
- `npm install`
- `npm run start`

`npm run build` will build the app to `./dist`.
Scripts:
- dev: Starts Vite dev server in the current directory
- build: builds the app to `./dist`
- preview: previews a specific build, starting it on a local port
- check-format: checks all formatting with prettier and displays warnings
- fix-format: attempts to fix formatting issues

## Maintainers

- [Robert Conde](https://github.com/RobertConde)
- [Brian Nielsen](https://github.com/bnielsen1)

## Documentation

For more documentation, see [OSC Docs Website](https://docs.ufosc.org/docs/swamp-scheduler)

## License

GNU Affero General Public License v3.0
GNU Affero General Public License v3.0