Running FCDex

Running FCDex

This guide explains how to run FCDex in development mode or start a compiled version of the application.

Before continuing, complete the steps in Installation.

Development mode

To start FCDex in development mode, run:

bun run dev

The current development script uses tsx watch to execute src/index.ts and watch for file changes.

Development mode is intended for local development and debugging.

Building FCDex

To compile the TypeScript project, run:

bun run build

The build script invokes the TypeScript compiler using the project's tsconfig.json.

Resolve any compilation errors before attempting to start the compiled application.

Starting FCDex

After a successful build, start the compiled application:

bun run start

The current start script executes dist/index.js, which is generated by the build process.

Available commands

Command	Description
bun install	Install project dependencies
bun run setup	Generate the local configuration if missing
bun run dev	Start development mode
bun run build	Compile the project
bun run start	Start the compiled application
bun run db:generate	Generate the Prisma client
bun run db:migrate	Run Prisma's development migration workflow
bun run db:studio	Open Prisma Studio
bun run lint	Run ESLint
bun run format	Format project files

Before starting the bot

Make sure that:

• Dependencies are installed.
• Your local config.ts file exists and contains the required settings.
• Discord credentials are valid.
• The PostgreSQL database is reachable.
• Required database setup has been completed.
• The bot has the Discord permissions required by its enabled features.

Stopping FCDex

Use your terminal's normal interrupt command to stop the running process.

Check the terminal output if the application reports errors during shutdown.

Production deployment

Production deployment guidance will be expanded as the project stabilizes.

Before running a production instance, consider:

• Secure credential management
• Database backups
• Error logging and monitoring
• Process restart behavior
• Database migration procedures
• Updating and maintaining the application

Do not run development database migrations against a production database without reviewing the migration plan.

Troubleshooting

If FCDex fails to start:

1. Read the full terminal error.
2. Verify your configuration.
3. Check the database connection.
4. Confirm that dependencies are installed.
5. Run bun run build and resolve any compilation errors.

For more help, visit the Troubleshooting page or open a GitHub issue.

Related pages

• Installation
• Configuration
• Database Setup
• Package System
• Troubleshooting