Installation

Installation

This guide explains how to install FCDex for local development or self-hosting.

FCDex is under active development, so some installation steps may change.

Requirements

Before starting, make sure you have:

• Git
• Bun
• A Discord application created in the Discord Developer Portal
• Access to a PostgreSQL database

1. Clone the repository

Open a terminal and run:

git clone https://github.com/saedevz/fcdex.git
cd fcdex

2. Install dependencies

Install the required packages using Bun:

bun install

3. Generate your configuration

Run the setup script:

bun run setup

This creates a local config.ts file using the configuration template embedded in the setup script.

If config.ts already exists, the setup script should preserve it rather than overwrite it.

4. Configure FCDex

Open config.ts and fill in the required settings, including your Discord credentials and other environment-specific configuration.

Create your bot through the Discord Developer Portal and configure the permissions and intents required by the features you use.

Never share your bot token or commit your credentials to GitHub.

5. Configure the database

Configure the PostgreSQL connection required by FCDex.

For more information, see Database Setup.

6. Generate the Prisma client

Run:

bun run db:generate

This generates the Prisma client from the project's Prisma schema.

7. Build and start FCDex

Build the project:

bun run build

Then start the compiled application:

bun run start

For development, use:

bun run dev

Troubleshooting

If installation fails:

1. Check that Git and Bun are installed correctly.
2. Confirm that dependencies installed successfully.
3. Verify your configuration and database connection.
4. Review the terminal error message.
5. If the issue persists, open a GitHub issue.

Security

• Keep your local config.ts private.
• Never commit Discord tokens or database credentials.
• Back up existing databases before making schema changes.
• Do not run migrations against an existing database without reviewing the migration plan.

---

For more information, see the FCDex Wiki home page.