tomodachi-share/DEVELOPMENT.md

TomodachiShare Development Instructions

This is probably outdated.

Welcome to the TomodachiShare development guide! This project uses pnpm for package management, Next.js with the app router for the backend, Vite with React for the frontend, Prisma for the database, TailwindCSS for styling, and TypeScript for type safety.

Getting started

To get the project up and running locally, follow these steps:

$ git clone https://github.com/trafficlunar/tomodachi-share
$ cd tomodachi-share
$ pnpm install

Prisma types are generated automatically, however, if you changed the schema or need to trigger a manual refresh:

# Generate Prisma client types
$ pnpm --filter backend prisma generate

# Or, if you've added new database properties
$ pnpm --filter backend prisma migrate dev
$ pnpm --filter backend prisma generate

I recommend opting out of Next.js' telemetry program but it is not a requirement.

$ pnpm --filter backend exec next telemetry disable

Environment variables

You'll need a PostgreSQL database and Redis database. I would recommend using Docker to set these up quickly. Just create a docker-compose.yaml with the following content and run docker compose up -d:

services:
  db:
    image: postgres
    restart: always
    shm_size: 1024mb
    ports:
      - 5432:5432
    environment:
      POSTGRES_PASSWORD: frieren

  adminer:
    image: adminer
    restart: always
    ports:
      - 8080:8080

  redis:
    image: redis
    restart: always
    ports:
      - 6379:6379

After starting the docker applications, apply TomodachiShare's database schema migrations.

$ pnpm --filter backend prisma migrate dev

After, in both the backend and frontend, make a copy of the .env.example file and rename it to .env. For the backend, the database variables should be pre-configured, but you'll need to fill in the rest of the variables.

For the AUTH_SECRET, run the following in the command line:

$ pnpx auth secret

Note

This command may put the secret in a file named .env.local, if that happens copy it and paste it into backend/.env

Now, let's get the Discord and GitHub authentication set up. If you don't plan on editing any code associated with authentication, you likely only need to setup one of these services.

For Discord, create an application in the developer portal, go to 'OAuth2', copy in the Client ID and Secret into the respective variables and also add this as a redirect URL: http://localhost:3000/api/auth/callback/discord.

For GitHub, navigate to your profile settings, then 'Developer Settings', and create a new application. Set the homepage URL to http://localhost:3000 and copy the Client ID and generate a new client secret. Finally, add in a callback URL with the value http://localhost:3000/api/auth/callback/github.

Google is annoying so I'm not explaining it.

Development Server

The frontend and backend need to be ran simulatenously, therefore you need two separate terminals.

# Terminal 1
$ pnpm --filter backend dev

# Terminal 2
$ pnpm --filter frontend dev

Building

It's a good idea to build the project locally before submitting a pull request. This helps catch any potential errors and see how things will look in a production environment.

# Build the project
$ pnpm --filter backend build
$ pnpm --filter frontend build

# Run the built version (Vite likes to change the port when this happens, so you probably need to change both .env files)
$ pnpm --filter backend start
$ pnpm --filter frontend build