A website for Online Master's of Science (OMS) course reviews at Georgia Tech.
- Production - https://omshub.org
- Storybook - https://storybook.omshub.org
- OMS Computer Science (OMSCS) - https://omscs.gatech.edu
- OMS Cybersecurity (OMSCY) - https://pe.gatech.edu/degrees/cybersecurity
- OMS Analytics (OMSA) - https://pe.gatech.edu/degrees/analytics
- How to Write a Git Commit Message - https://cbea.ms/git-commit
- Framework: Next.js 16 (App Router)
- UI Components: Mantine 7
- Database & Auth: Supabase
- Language: TypeScript
- Styling: Mantine CSS-in-JS + CSS Variables
- Deployment: Vercel
This project includes a .devcontainers configuration that can be used by VSCode to create a one-click development environment with Docker. The Docker container includes all of the dependencies you need to get started, forwards the NextJS and Storybook ports to your local machine, and mounts the repository into the container so changes persist outside of Docker.
To get started:
- Install the Remote - Containers VSCode extension.
- Open the repository with VSCode. You should see a prompt on the bottom left of the screen to open the project inside the container.
Clone the repository and then run the following commands to build the NextJS application:
pnpm install
pnpm buildTo start the project locally, run:
pnpm startOpen http://localhost:3000 with your browser to see the result.
Copy example.env to .env.local and fill in the required values:
cp example.env .env.localRequired environment variables:
NEXT_PUBLIC_SUPABASE_URL- Your Supabase project URLNEXT_PUBLIC_SUPABASE_PUBLISHABLE_KEY- Your Supabase publishable (anon) key
Optional environment variables:
NEXT_PUBLIC_GA_ID- Google Analytics IDNEXT_PUBLIC_CLARITY_ID- Microsoft Clarity IDGOOGLE_SITE_VERIFICATION- Google Search Console verification
pnpm dev— Starts the application in development mode athttp://localhost:3000.pnpm build— Creates an optimized production build of your application.pnpm start— Starts the application in production mode.pnpm clean— Removes.nextandnode_modulesdirectories.pnpm lint— Runs ESLint for all files in the project.pnpm prettier— Runs Prettier for all files in the project.pnpm fmt- Runpnpm prettierandpnpm lintsuccessively.pnpm precommit— Run commitizen ongit-staged files.pnpm storybook- Run storybook locally athttp://localhost:6006.
.github— GitHub configuration including the CI workflow..husky— Husky configuration and hooks.app— Next.js App Router pages and API routes.public— Static assets such as robots.txt, images, and favicon.src— Application source code, including components, lib, and utilities.src/components— React components.src/context— React context providers.src/lib— Library code including Supabase client, types, and utilities.
Using git commit will bring up a prompt that will fill out commit messages to the repo's commit connvention.
Commit messages must conform to the Conventional Commits specification.
The commit message should be structured as follows:
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
<type> must be one of the following:
| type | description |
|---|---|
| build | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
| chore | Changes that do not affect production; e.x., updating grunt tasks, etc. |
| ci | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
| docs | Documentation only changes |
| feat | A new feature |
| fix | A bug fix |
| perf | A code change that improves performance |
| refactor | A code change that neither fixes a bug nor adds a feature |
| revert | A commit that reverts a previous commit |
| style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
| test | Adding missing tests or correcting existing tests |
See the Conventional Commits specification for examples of valid commit messages.