README.md

SCCS Course Planner

The SCCS Course Planner is an all in one solution for planning your classes at Swarthmore College!

Looking to plan your classes? Visit the live site!

🏁 Getting Started

Install

Golang

NodeJS v18.18 or higher

Docker

Clone the Repo

  git clone --recursive https://github.com/swat-sccs/planner.git
  git checkout dev
  cd planner

Configure your .env file

Paste the following into a .env in the root of the project.

echo 'DATABASE_URL="postgresql://postgres:example@localhost:5432/planner_db"' > .env

Pase the following into a .env in the /swatscraper dir

  echo 'HOST=localhost
        SQL_USER=postgres
        PASS=example
        DBNAME=planner_db
        OPMODE="DEV"' > ./swatscraper/.env

Run the development server

docker compose -f docker-compose.debug.yml up -d
cd swatscraper

first run only:

go mod init github.com/swatscraper
go mod tidy
go run main.go -semester=spring -year=2025 # Change to semester of choice

View the dev site

Head on over to http://localhost:3000

(Optional) View the database visually and in the browser!

npx prisma studio

Head on over to http://localhost:5555. Use this to confirm your database is populated.

📡 Technologies in Use

• Next.js 14
• NextUI v2
• Tailwind CSS
• Tailwind Variants
• TypeScript
• Framer Motion
• next-themes
• Golang

License

Licensed under the MIT license.