> ## Documentation Index
> Fetch the complete documentation index at: https://docs.teamsbutactuallygood.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Dev Setup

Here you'll have a simple tutorial and how to install Teams but (actually) good.

<Info>
  Installing NodeJS is not mandatory, but recommended to avoid some potential issue down the line, bun can work without NodeJS and bun is used for that project.
</Info>

<Steps>
  <Step title="Install NodeJs">
    Go to the [NodeJS](https://nodejs.org/en/download) website, select your operating system and follow the steps on the website.

    <Frame>
      <img src="https://mintcdn.com/leonimust/1POCPWgLQhgR9tW_/images/node-installation.jpg?fit=max&auto=format&n=1POCPWgLQhgR9tW_&q=85&s=a32c4dccc5db37bad11ebd04a8a09fcb" alt="Node Installation" width="1089" height="537" data-path="images/node-installation.jpg" />
    </Frame>
  </Step>

  <Step title="Check if NodeJS works">
    Open your Terminal and run this command, it should return the NodeJS version (need to be 22 or more, older might cause some issues).

    ```bash theme={null}
    node --version
    ```
  </Step>

  <Step title="Install bun">
    `Teams but (actually) good` uses [bun](https://bun.com/), so you need to do the same :)

    Go to the [bun website](https://bun.com/), copy the command for your operating system (should be the one already selected) and past it in your terminal, then follow the steps of the installer.

    <Frame>
      <img src="https://mintcdn.com/leonimust/1POCPWgLQhgR9tW_/images/bun-installation.jpg?fit=max&auto=format&n=1POCPWgLQhgR9tW_&q=85&s=7c96ce6895d4d8733bd3bbce38b8dde0" alt="Bun Installation" width="723" height="164" data-path="images/bun-installation.jpg" />
    </Frame>
  </Step>

  <Step title="Check bun's version">
    Open your Terminal and run this command, it should return the bun version (don't forget to restart your terminal).

    ```bash theme={null}
    bun --version
    ```
  </Step>

  <Step title="Install git">
    Now go to the [git website](https://git-scm.com/install/), select your operating system and follow the step to install git, you don't need to understand the install option, you can mostly just next all the time and git will be installed on your pc.
  </Step>

  <Step title="Clone the repo">
    Now we can clone the repo, to do that, go into a folder where you wanna store the project in your terminal, and then run this command.

    ```bash theme={null}
    git clone https://github.com/LeonimusTTV/teams-but-actually-good
    ```
  </Step>

  <Step title="Open project">
    Now open the folder in your code editor, [VSCode](https://code.visualstudio.com/download) is good enough for that if you don't have any.
  </Step>

  <Step title="Install the dependencies">
    In the root folder of the project, open a terminal and run this command. This command will install all the dependencies needed to run the projet.

    ```bash theme={null}
    bun install
    ```
  </Step>

  <Step title="Check if the installation worked">
    Run this command to see if it generates correctly. If you got no errors, that means that everything worked fine.

    ```bash theme={null}
    bun run generate
    ```
  </Step>

  <Step title="Install rust (optional if you only want to build the extension)">
    Go to the [rust download page](https://rust-lang.org/tools/install/) and follow the instruction on the website, rust is needed to build the Tauri app, if you don't plan on using it, rust is therefore optional.
  </Step>
</Steps>

Now the setup is finished, to continue go check the information for devs.

<Card title="Information" icon="info" horizontal href="/dev-information">
  File structure, build commands and project overview
</Card>