README.md

🐊 Swamp Scheduler 📆

An open-source web app developed to help students at the University of Florida plan for classes next semester. It's available now!

Made with ❤️ by UF's Open Source Club.

Table of Contents

• Features
• Setup
• Usage
• Contribution
• Maintainers
• License

Features

• Course Explorer: Explore courses offered at the University of Florida
  • Find courses by course code, title, or instructor
• Course Selections: Make multiple courses selections with backup options.
  • Pick which classes you want (and remove which sections you don't)
• Schedule Generator: View and compare all the possible schedules and pick the one that fits your needs and wants.
  • View color-coded schedules that show what your day-to-day struggle workload will be

Installation

Prerequisites

Make sure to have npm installed.

Setup

Clone the Repo

Clone the repository to your local machine:

git clone <repository-url>

Install the Dependencies

Enter the web-app directory (/app) and install the dependencies (React, Tailwind CSS, etc.):

cd app
npm install

Usage:

• In the web-app directory:
  • Development: Run npm run dev to run the development server locally (with hot reloading).
  • Production: Run npm run build to build the app to /app/dist.

Contribution

Before you can make good contributions, you need to know a little bit about what we're using and how the web-app works. After that, you should be ready to get your hands dirty!

What We're Using (our Tech Stack)

This project is built using a variety of exciting technologies, including:

• TypeScript: The JavaScript programming language with a typing system (for Course objects, etc.)
  • Familiarize yourself with TypeScript’s documentation to understand the basics and best practices.
• React: A JavaScript library for building dynamic user interfaces.
  • The official React documentation is a great resource for learning about component-based architecture and state management.
• Tailwind CSS: A utility-first CSS framework.
  • Review the Tailwind CSS documentation for understanding utility-first styling and theming.
• Vite: Simply used as a build tool and development server.
  • Learn how to set up, configure, and use Vite from Vite’s official guide.

How It All Works

Be sure to read (yes, read) some of our code. Everything works better when we all understand what we're talking about.

SwampScheduler's documentation is a work-in-progress.

Give Me Something To Do!

There are lots of things that can be done, and a lot of them are on our back-burner.

Take a look at what issues (enhancements, bug fixes, and ideas) are open. If you find one you like, assign yourself and be sure to talk to other people about what you're doing (it helps us, the maintainers best allocate our resources).

Maintainers

We're your Technical Leads, Product Managers, and Mentors all-in-one:

• Robert Conde
• Brian Nielsen

License

GNU Affero General Public License v3.0