Running Attendizer

How do I run Attendizer?

Prep

You'll need a Vercel account to create the database and deploy the application.

Running Attendizer Locally

Prerequisites

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

Project Setup

1. Clone the repository to your computer (git clone)
2. Go into the project directory with cd attendizer
3. Install dependencies with npm install
4. Get the database credentials from the database's page in your Vercel account (.env format) and place them in a .env file in the current directory. (the same directory as package.json)
5. Add the following line to your .env file, changing the value if you want to set a custom key:

KEY=""

6. Generate the Prisma client (which lets us access the database) with npx prisma generate (and only the database is new, npx prisma db push too)
7. Start the project with npm run dev

Deploying to Vercel

1. Run npx vercel in the project's root directory, and follow the steps it provides.
2. If you want to deploy to production, pass the --prod flag to the previous command. This can also be done on Vercel's website.