USU CS 4610 Starter App

You are welcome to use this app as a starting point for any projects in this course.

Setup

Prerequisites

• node
• yarn (optional)
• docker

Install dependencies

In the root of the project run

yarn
# npm install

In the client folder run

yarn
# npm install

Create .env file

Create a new file called .env in the root of the project and copy the contents of .env.example into it. Change the values of the variables to fit your application.

Setup the database

In the root of the project run

docker compose up -d
# -d starts the container in the background

Running the application

In the root of the project run

yarn dev
# npm run dev

Open and new terminal tab and navigate to the client folder and run

yarn dev
# npm run dev

Visit your application at http://localhost:3000 (or whatever port you specified in your .env file)

NOTE: YOU MUST BE RUNNING BOTH THE CLIENT AND SERVER

Other Useful Commands

Generate and run migrations

yarn migrate-dev
# npm run migrate-dev

Run prisma console

yarn console
# npm run console

Reset the database

This command deletes all data from the database and recreates all of the tables from the existing migrations.

yarn migrate-reset
# npm run migrate-reset

Seed the Database

Seed script is found in prisma/seeds.ts. Update that script to add default data to your database - Note: seeds should be idempotent... this means that you should be able to run the seeds multiple times and the database should be in the same state regardless of whether its the first or 100th time you run it.

yarn seed
# npm run seed