Development Environment Setup

To contribute to ConvertX, you need to set up a local development environment. This project uses Bun.

Prerequisites

  1. Bun: Version 1.2.2 or higher.
  2. System Dependencies: You must install the underlying converter tools (FFmpeg, ImageMagick, etc.) on your local machine for the app to function correctly during development.
    • Tip: Refer to the Dockerfile in the repository root to see the list of apt-get packages required (e.g., ffmpeg, imagemagick, pandoc, inkscape).

Setup Steps

  1. Clone the repository: 

    git clone https://github.com/C4illin/ConvertX.git
cd ConvertX

  2. Install Node dependencies: 

    bun install

  3. Run Development Server: 

    bun run dev
    The server will start at http://localhost:3000.

  4. Linting & Formatting:

    • Lint: bun run lint
    • Format: bun run format

VS Code

A .devcontainer configuration is provided. If you use VS Code with the Dev Containers extension, you can open the project inside a container that has all dependencies pre-installed. This is the recommended approach to avoid installing system binaries manually.