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

various README fixes (#3)

Browse source 
* add instructions on adding GITHUB_TOKEN as env variable on machine

* add .github-token to gitignore and add additional info in build instructions

* remove github-token from gitignore because its meant to be in home dir. Bold this part in the README so its more clear

* add ctags installation instructions to readme

* link to ctags repo in README

* remove unnecessary line change in gitignore
This commit is contained in:
Michael Sukkarieh 2024-09-19 13:28:10 -07:00 committed by GitHub
parent 7cb0e7e691
commit 03fc50afd2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 20 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -53,7 +53,15 @@ Sourcebot also supports indexing GitLab & BitBucket. Checkout the [index.json](.
<details open> <details open>
<summary><img src="https://github.com/favicon.ico" width="16" height="16" /> GitHub</summary> <summary><img src="https://github.com/favicon.ico" width="16" height="16" /> GitHub</summary>
Generate a GitHub Personal Access Token (PAT) [here](https://github.com/settings/tokens/new). If you are indexing public repositories only, you can select the `public_repo` scope, otherwise you will need the `repo` scope. Generate a GitHub Personal Access Token (PAT) [here](https://github.com/settings/tokens/new). If you're only indexing public repositories select the `public_repo` scope; otherwise, select the `repo` scope.
You'll need to pass this PAT each time you run Sourcebot, so we recommend adding it as an environment variable. In this guide, we'll add the Github PAT as an environment variable called `GITHUB_TOKEN`:
```sh
export GITHUB_TOKEN=<your-token-here>
```
If you'd like to persist this environment variable across shell sessions, please add this line to your shell config file (ex. `~/.bashrc`, `~/.bash_profile`, etc)
</details> </details>
@ -78,8 +86,9 @@ Sourcebot also supports indexing GitLab & BitBucket. Checkout the [index.json](.
<details open> <details open>
<summary><img src="https://github.com/favicon.ico" width="16" height="16" /> GitHub</summary> <summary><img src="https://github.com/favicon.ico" width="16" height="16" /> GitHub</summary>
Run the `sourcebot` docker image, passing in the Github PAT you generated in the previous step as an environment variable called `GITHUB_TOKEN`:
```sh ```sh
docker run -p 3000:3000 --rm --name sourcebot -v $(pwd):/data -e GITHUB_TOKEN=<token> ghcr.io/taqlaai/sourcebot:main docker run -p 3000:3000 --rm --name sourcebot -v $(pwd):/data -e GITHUB_TOKEN=$GITHUB_TOKEN ghcr.io/taqlaai/sourcebot:main
``` ```
</details> </details>
@ -119,14 +128,18 @@ Sourcebot also supports indexing GitLab & BitBucket. Checkout the [index.json](.
## Building Sourcebot ## Building Sourcebot
0. Install <a href="https://go.dev/"><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> 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. Clone the repository with submodules: 2. Install [ctags](https://github.com/universal-ctags/ctags) (required by zoekt-indexserver):
Mac: `brew install universal-ctags`
Ubuntu: `apt-get install universal-ctags`
3. Clone the repository with submodules:
```sh ```sh
git clone --recurse-submodules https://github.com/TaqlaAI/sourcebot.git git clone --recurse-submodules https://github.com/TaqlaAI/sourcebot.git
``` ```
2. Run make to build zoekt and install dependencies: 4. Run make to build zoekt and install dependencies:
```sh ```sh
cd sourcebot cd sourcebot
make make
@ -157,7 +170,7 @@ The zoekt binaries and web dependencies are placed into `bin` and `node_modules`
Generate a GitHub Personal Access Token (PAT) [here](https://github.com/settings/tokens/new). If you are indexing public repositories only, you can select the `public_repo` scope, otherwise you will need the `repo` scope. Generate a GitHub Personal Access Token (PAT) [here](https://github.com/settings/tokens/new). If you are indexing public repositories only, you can select the `public_repo` scope, otherwise you will need the `repo` scope.
Create a text file named `.github-token` in your home directory and paste the token in it. The file should look like: Create a text file named `.github-token` **in your home directory** and paste the token in it. The file should look like:
```sh ```sh
ghp_... ghp_...
``` ```

2
package.json
View file

@ -5,7 +5,7 @@
"scripts": { "scripts": {
"dev": "npm-run-all --print-label --parallel next:dev zoekt:webserver zoekt:indexserver", "dev": "npm-run-all --print-label --parallel next:dev zoekt:webserver zoekt:indexserver",
"zoekt:webserver": "export PATH=\"$PWD/bin:$PATH\" && zoekt-webserver -index .sourcebot/index -rpc", "zoekt:webserver": "export PATH=\"$PWD/bin:$PATH\" && zoekt-webserver -index .sourcebot/index -rpc",
"zoekt:indexserver": "export PATH=\"$PWD/bin:$PATH\" && zoekt-indexserver -data_dir .sourcebot -mirror_config config.json", "zoekt:indexserver": "export PATH=\"$PWD/bin:$PATH\" && export CTAGS_COMMAND=ctags && zoekt-indexserver -data_dir .sourcebot -mirror_config config.json",
"next:dev": "next dev", "next:dev": "next dev",
"build": "next build", "build": "next build",
"start": "next start", "start": "next start",