Getting Started

Installing Node.js

Windows

Go to the official Node.js download page: https://nodejs.org/en/download

Download the LTS Windows installer and run it. When it completes, open a new PowerShell or Command Prompt and verify the install:

node -v
npm -v

MacOS / Linux

For MacOS and Linux, you can use NVM to manage Node versions. You can also download individual version installers from the same link as the Windows section.

Install NVM by following the steps on the project repo: https://github.com/nvm-sh/nvm#installing-and-updating

When the install script completes, restart your terminal and run:

nvm install --lts

Finally, verify the installation:

node -v
npm -v

Cloning Blueward

Navigate to a directory where you keep your projects and run:

git clone https://github.com/Kickblip/blueward
cd blueward

Install the packages that Blueward uses:

npm install

Create a new branch for your edits and replace feature/my-new-feature with whatever you want to name it:

git switch -c feature/my-new-feature

Environment variables

If you are interested in contributing to Blueward first make sure you can sign in to UT Austin Stache.

Then reach out to @kickball on discord and join the Longhorn LoL server. Make sure to include your name and EID in your request.

Setting your environment variables

After receiving the environment variables you will need to copy them into your local project.

Locate the .env.example file in your project directory and rename it to .env. Then, populate the corresponding values with the key names.

Running the server

Finally, run npm run dev in your terminal to start the development server and then open https://localhost:3000 in a new browser tab.