Prerequisites

This project requires NodeJS (version 16 or later), PNPM and docker (recommended but optional). Node, PNPM and Docker are really easy to install. To make sure you have them available on your machine, try running the following command.

$ pnpm -v && node -v && docker -v

Table of contents

• Project Name
  • Prerequisites
  • Table of contents
  • Getting Started
  • Installation

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Installation

BEFORE YOU INSTALL: please read the prerequisites

Start with cloning this repo on your local machine:

$ git clone https://github.com/Yedidyar/toast-tracker
$ cd toast-tracker

To install and set up, run:

$ pnpm install

Setup Database

You can do it without Docker, but Docker is the easiest.

$ docker compose up

Sync the db:

$ pnpx prisma db push
# for an admin panel
$ pnpx prisma studio

Setup Next Auth

The simple way is to use the discord provider.

You should fill out the rest of the environment variables with mock data since the environment variables will be validated at runtime.

Serving the app

don't forget to add the env file see the env.example

$ pnpm run dev