/CypherVII-Schedule-Advisor

Degree Works with a more intuitive UX/UI

Primary LanguageJavaScript

CypherVII-Schedule-Advisor

Degree Works with a more intuitive UX/UI

Installation

Prerequisites

  1. A recent installation of Go. Here is the download for Windows. Here is the download for macOS
  2. A recent installation of node and npm. Here is the download for Windows. Here is the download for macOS
  3. Git if you don't already have it installed.

Once downloaded successfully, your command promp (Terminal if using mac) should look something like this when you run the following commands:

Windows Command Prompt After Download

Project Setup

Open a terminal(macOS) or command prompt(Windows). cd to the folder you wish to work out of. Then run the following command:

Go Setup

mkdir cypherVIIWorkspace
cd cypherVIIWorkspace
git clone https://github.com/jacobsomer/CypherVII-Schedule-Advisor.git
cd CypherVII-Schedule-Advisor
git checkout -b myLocalBranch

Backend Setup

From the root of the project, run the following commands to start the go server.

cd backend
go run main.go

Once you have done this. Feel free to open up a code editor such as VSCode in the CypherVII-Schedule-Advisor folder. Open go.py and begin coding! Here is what my console looked like: Screenshot (41)

Frontend Setup

From the root of the project, run the following commands to start the react server.

cd frontend
npm i
npm start

Speed Tip

If you are using VScode, I recommend installing this extension to make debugging go a lot easier.

Other Resources

  1. Design Doc
  2. Gin Webframework