ti.sil/sourcebot
1
0
Fork 0
mirror of https://github.com/sourcebot-dev/sourcebot.git synced 2025-12-11 20:05:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

fix ordering in contributing doc

Browse source
This commit is contained in:
msukkari 2025-06-03 18:58:07 -07:00
parent 749bfc28f3
commit d5c4486664
1 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
CONTRIBUTING.md
View file

@ -2,7 +2,7 @@
>[!NOTE] >[!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). > 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 <a href="https://go.dev/doc/install"><img src="https://go.dev/favicon.ico" width="16" height="16"> go</a>, and <a href="https://nodejs.org/"><img src="https://nodejs.org/favicon.ico" width="16" height="16"> NodeJS</a>. Note that a NodeJS version of at least `21.1.0` is required. 1. Install <a href="https://go.dev/doc/install"><img src="https://go.dev/favicon.ico" width="16" height="16"> go</a>, <a href="https://docs.docker.com/get-started/get-docker/"><img src="https://www.docker.com/favicon.ico" width="16" height="16"> docker</a>, and <a href="https://nodejs.org/"><img src="https://nodejs.org/favicon.ico" width="16" height="16"> NodeJS</a>. 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) 2. Install [ctags](https://github.com/universal-ctags/ctags) (required by zoekt)
```sh ```sh
@ -13,18 +13,16 @@
snap install universal-ctags snap install universal-ctags
``` ```
3. Install <a href="https://docs.docker.com/get-started/get-docker/"><img src="https://www.docker.com/favicon.ico" width="16" height="16"> docker</a> and start the development Docker containers for PostgreSQL and Redis. 3. Install `yarn`:
```sh ```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 ```sh
git clone --recurse-submodules https://github.com/sourcebot-dev/sourcebot.git git clone --recurse-submodules https://github.com/sourcebot-dev/sourcebot.git
``` ```
4. Run `make` to build zoekt and install dependencies:
5. Run `make` to build zoekt and install dependencies:
```sh ```sh
cd sourcebot cd sourcebot
make make
@ -32,9 +30,15 @@
The zoekt binaries and web dependencies are placed into `bin` and `node_modules` respectively. 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. 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: 8. Start Sourcebot with the command:
```sh ```sh