fool1280 / rev-registration

Automatic class scheduler for Texas A&M written with Python+Django and React+Typescript

Rev Registration

Description

Rev Registration is an automatic class scheduler for Texas A&M, aimed at easing the process of course registration by generating compatible schedules given the courses a student would like to take and what preferences they have. Simply select a term, pick your courses, mark off when you're not available, and we'll generate schedules for you!

For instance, imagine you've settled on 3 sections of a course you are fine with having and are having trouble finding a schedule without conflicts. Select all 3 under the Section customization level, add in your other classes, and let the schedule generator create schedules for you without time conflicts!

Features:

• Automatic schedule generation
• Block off busy times (availabilities)
• Displays grade distribution
• Shows current seats remaining
• Search by course number or title
• Filter for only honors or online sections
• Visual display of schedules
• Remembers preferences for easy access during registration
• Login with Google
• Save, rename, and delete generated schedules
• Filter out full sections

Installation

Follow these steps to start a local Django server using a PostgreSQL database:

1. If you don’t have it already, download Python from here.

2. To install the packages, you first need to make a virtual environment for Python, which will help us ensure that our libraries & Python versions are unified. You can do so be by running:

   • python3 -m venv env
     • This creates a virtual environment in the env/ folder.
     • In here you'll see a directory containing the libraries that will be installed in the next step(Lib/ on Windows)
     • You'll also see a folder(Scripts/ on Windows & bin/ on Unix systems) that contains the scripts that you need to start the virtual environment.
   • Next, for Unix systems run: source env/bin/activate
   • And for Windows, in Powershell run: ./env/Scripts/activate
     • If you get a permissions error that says: execution of scripts is disabled on this system, then open another PowerShell as Administrator and run Set-ExecutionPolicy -ExecutionPolicy RemoteSigned.
       • Alternatively, you can just run the original script as Administrator.
   • You will need to do source env/bin/activate or ./env/Scripts/activate anytime you want to interact with the server(i.e. to run it with python manage.py runserver)

3. Now, run pip install -r requirements.txt to install the necessary packages for the project.

4. Set up a PostgresQL server by following one of these guides, and make sure you set the name of the database when prompted to dbautoscheduler:

   • Windows
   • Mac
   • Linux
   • You may also want to download pgAdmin 4 for ease of database management (it can be installed alongside PostgreSQL if you used the above Windows guide). It can be downloaded from here.

5. (Only if using pgAdmin) Create a new server by opening pgAdmin and right-click “Servers->Create->Server…”. Set a name pgAdmin will use (it can be anything), then change to the Connection tab. Ensure the following settings are being used:

Host name/address: localhost
Port: 5432
Maintenance database: postgres
Username: postgres
Password: (not necessary)

6. Ensure the database dbautoscheduler has been created: Using psql: Type \l in the psql prompt and see if dbautoscheduler is in the list. Using pgAdmin: Click the name of the server you created, and see if dbautoscheduler is in the tree menu.
7. If you'd like to get the current project running, you can clone the repository with git clone https://github.com/gannonprudhomme/AutoScheduler/ and run the steps below.

Running

Before running any commands, if you're not running in the virtual environment(you should see (env) somewhere in your current terminal line), run source env/bin/activate or ./env/Scripts/activate.

You will have to make and apply migrations before running the server (and whenever our models are changed). To generate the files that django uses to apply migrations, run ./manage.py makemigrations, and to then apply these to the database, run ./manage.py migrate.

After migrating, you can run the server with ./manage.py runserver. When running for the first time, you will have to configure autoscheduler/autoscheduler/config/postgres-info.json with your postgres username and password. This file will be automatically created if you run ./manage.py runserver.

If ./manage.py isn't working, try to use python manage.py or python3 manage.py in place of it.