Faithful Mods

Prerequisites

• Node 20
• Docker

Project installation

Clone the repository

git clone "https://github.com/Juknum/faithful-mods"
cd ./faithful-mods

# install dependencies
npm install

Setup .env file

# local/prod postgres database url
DATABASE_URL="postgresql://postgres:postgres@localhost:5555/fm_postgres?schema=public"

# openssl rand -base64 32
AUTH_SECRET=

NEXT_PUBLIC_APP_URL="http://localhost:3000"

# Github OAuth credentials, create a new OAuth app at
# https://github.com/settings/developers
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=

Setup the database

Download docker and run the following command to start a Postgres container:

docker compose up -d --force-recreate

Setup Prisma

# generate prisma client types (this is done when doing "npm install")
npx prisma generate
# apply migrations
npm run db:apply
# create a new migration file
npm run db:migrate

Start the app

npm run dev