<div align="center"> <h1>h4u. | handoutsforyou.</h1> <p>One stop website for your Handouts, Academic Resources, Practice School Queries, Course Reviews, Course Prerequisites, etc. This facilitates the accessibility of course handouts, notes, resources, and contains a course review system, notes sharing system..</p> <img src="https://img.shields.io/github/last-commit/thenicekat/handoutsforyou?style=for-the-badge&color=74c7ec&labelColor=111827" alt="Last Commit"> <img src="https://img.shields.io/github/stars/thenicekat/handoutsforyou?style=for-the-badge&color=facc15&labelColor=111827" alt="GitHub Stars"> <img src="https://img.shields.io/github/repo-size/thenicekat/handoutsforyou?style=for-the-badge&color=a78bfa&labelColor=111827" alt="Repo Size"> <img src="https://img.shields.io/github/license/thenicekat/handoutsforyou?style=for-the-badge&color=34d399&labelColor=111827" alt="License"> </div>

Features available.

| Section | Description | | ----------------------------- | ---------------------------------------------------------------------- | | Courses | Prereqs, Handouts, PYQs, Grading, Reviews and Notes | | Practice School | PS Cutoffs, Chronicles, Reviews and more | | Zob | Summer Internship Chronicles, Placement Chronicles and other resources | | Research & Higher Studies | Chronicles and other resources |

Setup.

Dependencies.

First install the dependencies by using pnpm after installing pnpm
This is essentially installing all the libraries needed for this website to run.

pnpm install

Create a copy of the file .env.testing and rename it to .env.local. All your environment variables must be put in this file.

Oauth .

You need to set up google oauth using your bits email for signing into the website. You can use the next auth guide for the same .

You would need to populate the following for auth to work.

GOOGLE_CLIENT_ID=""
GOOGLE_CLIENT_SECRET=""
NEXTAUTH_SECRET=""

Google Drive

The following environment variables are required to be populated:

GOOGLE_DRIVE_CLIENT_ID=
GOOGLE_DRIVE_CLIENT_SECRET=
GOOGLE_DRIVE_REFRESH_TOKEN=

GOOGLE_SERVICE_ACCOUNT_EMAIL=
GOOGLE_SERVICE_ACCOUNT_PRIVATE_KEY=

# Specific to 'BITS of Advice' section
GOOGLE_DRIVE_BITSOFA_FOLDER_ID=

# For the other sections
GOOGLE_DRIVE_PLACEMENT_CHRONICLES_FOLDER_ID=
GOOGLE_DRIVE_SI_CHRONICLES_FOLDER_ID=
GOOGLE_DRIVE_PS_CHRONICLES_FOLDER_ID=
GOOGLE_DRIVE_HANDOUTS_FOLDER_ID=
GOOGLE_DRIVE_PYQS_FOLDER_ID=

The first two (GOOGLE_DRIVE_CLIENT_ID and GOOGLE_DRIVE_CLIENT_SECRET) are the same as the GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET

To obtain GOOGLE_DRIVE_REFRESH_TOKEN, you must do the following:

Go to OAuth2 Playground and click on the settings icon on the top right
Check the box saying "Use your own OAuth credentials"
Input the GOOGLE_DRIVE_CLIENT_ID and GOOGLE_DRIVE_CLIENT_SECRET
Select Google Drive v3 API's https://www.googleapis.com/auth/drive scope
Click Authorize APIs, and ensure you log in with the Google account which h4u will use for fetching data
Click on Exchange authorization code for tokens and obtain the refresh token (GOOGLE_DRIVE_REFRESH_TOKEN)

To create a service account (a bot account that is required for this to work):

Enable the Google Drive API
Go to Credentials -> Create credentials (choose service)
Enter the details, choose Basic -> Editor in roles and hit done; this is GOOGLE_SERVICE_ACCOUNT_EMAIL
Download the JSON containing keys and populate GOOGLE_SERVICE_ACCOUNT_PRIVATE_KEY

To obtain any GOOGLE_DRIVE_<folder_name>_FOLDER_ID, copy the folder_id from https://drive.google.com/file/u/1/d/<folder_id>/

Database.

Supabase is used as the database for h4u. You can run Supabase locally using Docker for development and testing. Note: Make sure you have Docker installed before proceeding.

Start the Supabase Instance

This command starts a minimal Supabase stack, excluding optional services like auth, realtime, storage, etc.:

pnpm dlx supabase start -x gotrue,realtime,storage-api,imgproxy,mailpit,edge-runtime,logflare,vector

On the first run, this may take some time as Docker images are downloaded.

Run Migrations and Seed the Database

Once the instance is running, apply the database schema and initialize seed data:

pnpm dlx supabase db reset

Populate the following env variables from supabase studio.

SUPABASE_API_KEY=""
SUPABASE_URL=""

Stop the Supabase Instance

To shut down your local Supabase services:

pnpm dlx supabase stop

Development Server.

Run the development server using the following command. Open http://localhost:3000 with your browser to see the result.

pnpm run dev

Updating the Supabase Schema

To update the database schema in your local Supabase instance:

Make your changes in /supabase/schemas/init.sql.
Generate a new migration file by running:

pnpm dlx supabase db diff -f <migration_name>

This will create a new migration file in /supabase/migrations.

Ensure that your Supabase instance is running, then apply your migrations with:

pnpm dlx supabase migration up

Note: The seed data can be modified by updating the file at /supabase/seed.sql

Maintenance/Scripts

Accessing Supabase Studio and Credentials

After Supabase starts, a local Supabase Studio URL will be displayed in the terminal (typically http://localhost:54323). You can use this interface to:

Explore and edit your database
Run SQL queries
Retrieve your Supabase API credentials (URL and anon key) for local development

Course Reviews.

add_reviews.py -> There is only one script which pushed directly to the database.

Course Prereqs.

prereqs.py -> This is the script which parses data from course prereqs excel.
Use this to convert the excel TTD puts out on cms regarding prereqs to a json format
I don't think you'll need to use this for a long long time :)

Practice School.

Download the most up to date copy of PS2_master.csv
Add the new year to be added to the end of the CSV
Run similar_names_filter script on this csv to ensure that it gives you all the similar names in that particular csv from the company column
This will generate a soundex_filter.txt which contains all the companies which are similar in the format of CompanyA<|>CompanyB now the task here is to ensure only those companies which are together are in the same line. For example:

National Aerospace Lab<|>National Aerospace Laboratories<|>National Aerospace Laboratory<|>National Chemical Laboratory<|>National Chemical Laboratory (NCL), Pune<|>National Chemical Laboratory - Pune<|>National Chemical Laboratory, Pune<|>National Council for Cement and Building Materials<|>National Council of Applied Economic Research<|>National Instruments<|>National Instruments (Bangalore)<|>National Instruments Systems (India) Pvt. Ltd. - Bengaluru<|>National Instruments, Bangalore

should become

National Aerospace Lab<|>National Aerospace Laboratories<|>National Aerospace Laboratory
National Chemical Laboratory<|>National Chemical Laboratory (NCL), Pune<|>National Chemical Laboratory - Pune<|>National Chemical Laboratory, Pune
National Council for Cement and Building Materials
National Council of Applied Economic Research
National Instruments<|>National Instruments (Bangalore)<|>National Instruments Systems (India) Pvt. Ltd. - Bengaluru<|>National Instruments, Bangalore

Now the next step is to run data_consolidator script which consolidates all the stations of same name into one station. NOTE: Incase you want to ignore two completely dissimilar companies add it to scripts/ignore.txt
In the end run parse_ps to generate json from csv

Contributors - Developers

Divyateja Pasupuleti
Adarsh Das
Pratyush Nair
Namit Bhutani
Anirudh Agarwal
Santrupti Behera

Contributors - Content

Redirected to https://handoutsforyou.vercel.app

Handoutsforyou

Install / Use

README