Skip to content

Running Attendizer

Jump to bottom
thegu5 edited this page Nov 7, 2022 · 10 revisions

How do I run Attendizer?

Currently, Attendizer is run in two separate parts. This makes running it less simple than just typing a few commands into a terminal.

Actually, all you have to do is type a few commands into two terminals!

Running Attendizer Locally

Preparing the Environment

  1. Install Node.js from here. This will also get you npm, although you can use a Node Version Manager as detailed here.

Starting the Client and Server

  1. Clone the repository to your computer. (git clone)
  2. First, open up two terminals in the home directory of Attendizer. This can be done in VSCode or with just normally brought up terminals.
  3. From here, type cd client into one terminal, and cd server into the other.
  4. Then, in both terminals, type npm i.
  5. From there just type npm run dev into both of them, and then both the client and server will be running locally.

IMPORTANT: Make sure to set a key in the .env file (/server/.env)! The default is an empty string.

Clone this wiki locally