mirror of
https://github.com/sourcebot-dev/sourcebot.git
synced 2025-12-11 20:05:25 +00:00
9b13492cb3
* chore: Fix misc typos (UI, docs, code...) * chore(dev): Support PATH with spaces in Makefile E.g. `Application Support` on MacOS * chore: Typos in schema v2 description * chore: more typos * chore(dev): Add _typos.toml
50 lines
1.9 KiB
Markdown
50 lines
1.9 KiB
Markdown
## Build from source
|
|
>[!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 <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)
|
|
```sh
|
|
// macOS:
|
|
brew install universal-ctags
|
|
|
|
// Linux:
|
|
snap install universal-ctags
|
|
```
|
|
|
|
3. Install `yarn`:
|
|
```sh
|
|
npm install --global yarn
|
|
```
|
|
|
|
3. Clone the repository with submodules:
|
|
```sh
|
|
git clone --recurse-submodules https://github.com/sourcebot-dev/sourcebot.git
|
|
```
|
|
4. Run `make` to build zoekt and install dependencies:
|
|
```sh
|
|
cd sourcebot
|
|
make
|
|
```
|
|
|
|
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 declarative 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
|
|
yarn dev
|
|
```
|
|
|
|
A `.sourcebot` directory will be created and zoekt will begin to index the repositories found in the `config.json` file.
|
|
|
|
9. Start searching at `http://localhost:3000`.
|