Skip to content

A better degree guide for the UO Computer Science, Math, and Data Science majors

License

Notifications You must be signed in to change notification settings

TeamPopsicle/cmd-degree-guide

Repository files navigation

CMD Degree Guide

Developed by Team Popsicle (Ethan Cha, Haley Figone, Peyton Elebash, Yaya Yao)

This is a Next.js project bootstrapped with create-next-app.

The full web app for CMD Degree Guide can be viewed here

Getting Started for Developing

You will need to provide your own MySQL database and data. The database will need to be structured with two tables with their schemas as shown:

Database Diagram

Provide the credentials to access the database as well as the API keys for the app to send database queries using environment variables. You can also choose to put the environment variables in a .env.local file, which needs to be filled like so:

Example .env.local:

MYSQL_HOST= your.mysql.host
MYSQL_PORT= 3306
MYSQL_DATABASE= your_db_name
MYSQL_USER= your_user_name
MYSQL_PASSWORD= your_password
NEXT_PUBLIC_API_KEY= my-api-key
PRIVATE_API_KEY= my-api-key

NEXT_PUBLIC_API_KEY and PRIVATE_API_KEY can be whatever you want, but they must be the same.

Install all dependencies using your preferred Node package manager:

npm install
# or
yarn install
# or
pnpm install
# or
bun install

Then run the development environment

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

About

A better degree guide for the UO Computer Science, Math, and Data Science majors

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published