Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/discordplace/discord.place/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through cloning the repository, installing dependencies, and starting both the server and the client.
Make sure you have completed all the steps in Prerequisites before continuing.
1

Clone the repository

Clone the discord.place repository to your local machine:
git clone https://github.com/discordplace/discord.place.git
2

Navigate to the repository

Move into the cloned directory:
cd discord.place
3

Install server dependencies

Install the Node.js dependencies for the server:
cd server
npm install
4

Install client dependencies

Install the Node.js dependencies for the client:
cd ../client
npm install
5

Create environment files

Create a .env file in both the server and client directories. You can use the example files as a starting point:
cp server/.example.env server/.env
cp client/.example.env client/.env
Fill in the values for each file. See the Configuration overview for guidance on what each variable does.
The CLIENT_SECRET value must be identical in both server/.env and client/.env. This shared secret is used by the server to verify requests coming from the client’s server-side rendering. You can use any random string, but it must match exactly on both sides.
6

Start the server

From the repository root, start the Express.js server:
cd server
npm start
The server listens on port 3001 by default.
7

Start the client

In a separate terminal, start the Next.js client in development mode:
cd client
npm run dev
The client listens on port 3000 by default.
8

Open the site

Open your browser and navigate to:
http://localhost:3000
You should see the discord.place homepage running locally.

Next steps

Once the site is running, configure your Discord application, storage, and other services:

Configuration overview

Understand how the .env files and config files relate to each other.

Client environment variables

Full reference for every variable in client/.env.

Server environment variables

Full reference for every variable in server/.env.

Server config.yml

Reference for server/config.yml application settings.

Build docs developers (and LLMs) love