diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 40e0c197..3016d9d8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ >[!NOTE] > Building from source is only required if you'd like to contribute. The recommended way to use Sourcebot is to use the [pre-built docker image](https://github.com/sourcebot-dev/sourcebot/pkgs/container/sourcebot). -1. Install go, and NodeJS. Note that a NodeJS version of at least `21.1.0` is required. +1. Install go, docker, and NodeJS. Note that a NodeJS version of at least `21.1.0` is required. 2. Install [ctags](https://github.com/universal-ctags/ctags) (required by zoekt) ```sh @@ -13,18 +13,16 @@ snap install universal-ctags ``` -3. Install docker and start the development Docker containers for PostgreSQL and Redis. - +3. Install `yarn`: ```sh - docker compose -f docker-compose-dev.yml up -d + npm install --global yarn ``` -4. Clone the repository with submodules: +3. Clone the repository with submodules: ```sh git clone --recurse-submodules https://github.com/sourcebot-dev/sourcebot.git ``` - -5. Run `make` to build zoekt and install dependencies: +4. Run `make` to build zoekt and install dependencies: ```sh cd sourcebot make @@ -32,9 +30,15 @@ The zoekt binaries and web dependencies are placed into `bin` and `node_modules` respectively. +5. Start the development Docker containers for PostgreSQL and Redis. + + ```sh + docker compose -f docker-compose-dev.yml up -d + ``` + 6. Create a copy of `.env.development` and name it `.env.development.local`. Update the required environment variables. -7. If you're using a declerative configuration file (the default behavior if you didn't enable auth), create a configuration file and update the `CONFIG_PATH` environment variable in your `.env.development.local` file. +7. If you're using a declerative configuration file, create a configuration file and update the `CONFIG_PATH` environment variable in your `.env.development.local` file. 8. Start Sourcebot with the command: ```sh