Skip to content

Latest commit

 

History

History
70 lines (54 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

70 lines (54 loc) · 2.51 KB
Raw

Contributing

Table of Contents

Built With

  • Next.js
  • TypeScript
  • JavaScript
  • Sass/SCSS
  • Material UI

Getting Started

UT Registration Planner is composed of 2 main sections. The Next.js and Chrome Extension folder. Depending on what part of the project you want to contribute to will determine your workflow.

Standards and Guidelines

In order for UT Registration Planner to maintain a clean and organized codebase, we follow certain styles which are enforced by Prettier and the prettier-vscode VS Code extension called "Prettier - Code formatter".

Note: You will need to select which code formatter VS Code wants to use (It will prompt you to choose).

Next.js

Prerequisites

  • Node.js 18.3.0

Recommended Workflow

The Next.js section of this project is located under the ut-registration-planner folder. Open up VS Code and open the UT Registration Planner project root with File > Open Folder... UT Registration Planner.

Then open up the integrated terminal in VS Code and navigate to the ut-registration-plannerfolder.

cd ut-registration-planner

Installation and Running Dev Server

Install npm packages and dependencies

npm install

Run the development server

npm run dev

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

Chrome Extension

Recommended Workflow

The Chrome Extension section of this project is located under the extension folder. Open up VS Code and open the UT Registration Planner project root with File > Open Folder... UT Registration Planner.

  1. Head over to chrome://extensions in a new chrome profile (recommended to prevent conflicts).
  2. Enable Developer Mode
  3. Click the Load Unpacked button
  4. Select the UT Registration Planner/extension folder

Important!

You will have to navigate to chrome://extensions and refresh the UT Registration Planner Chrome Extension and the pages it affects after every change for the changes to take effect.