Sussed

Suss out your app's usability!

Installation

Install the dependencies:

npm install

Development

Environment variables

You will need to set some environment variables before running the app. Start by creating a .env file in the root of the project. You can do this by copying the existing .env.example file:

cp .env.example .env

You will also need a .env.local file for things like NextAuth.

cp .env.local.example .env.local

Running the app

First, run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Prisma

To push the prisma schema to the database:

npx prisma db push

To seed the database with test data:

npx prisma db seed

To open prisma studio to view the database with a UI:

npx prisma studio

To migrate the database:

npx prisma migrate dev

How to squash migrations

Learn more about Prisma here

Testing

E2E

This project uses Cypress for end to end testing.

To open Cypress:

npm run cy:open

Learn more about Cypress here

When running e2e tests in the Github CI, you'll need to add the AUTH_SECRET environment variable to your repository's secrets.

Unit Testing

This project uses Vitest for unit testing.

To run unit tests:

npm run test

Learn more about Vitest here

Learn More

This is a Next.js project bootstrapped with create-next-app.

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out Vercel's Next.js deployment documentation for more details.