Skip to content

Commit 49ccfc3

Browse files
committed
docs: mention log4rs config
1 parent 1b40119 commit 49ccfc3

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/dev_setup.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,19 @@ The first thing that is recommended is setting `APP_DEBUG` to `1` if you are run
3636

3737
The second step is setting our `DATABASE_URL`. It has a specific structure: `postgres://{username}:{password}@{db_host}/{database}`. In our case, after completing it with our data, the URL becomes: `postgres://geode:geode@localhost/geode`.
3838

39+
> [!TIP]
40+
> You can get away with setting this up by manually adding developers to the database. Just add columns to `developers` and `auth_tokens` manually, while keeping in mind tokens in the database are sha256'd uuid tokens.
41+
3942
Third, we need to setup a local GitHub OAuth app. Since the index doesn't store passwords, and uses GitHub for logins, we need this step to login into the index. Check out this guide for [creating a GitHub OAuth app](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app), then fill in the client ID and secret of your app inside the .env file.
4043

4144
Finally, run your migrations from the project directory using `sqlx migrate run`
4245

46+
Next up, set up the log4rs config file found in `config`:
47+
```bash
48+
cp config/log4rs.example.yaml config/log4rs.yaml
49+
```
50+
Feel free to change the settings, but the default works fine.
51+
4352
After all of this is done, you should be able to run `cargo run` inside the index directory. The migrations will be ran automatically, and the index will start. You can check `http://localhost:8000` (if you haven't changed the app port) to see if it all works.
4453

4554
## 3. Admin users

0 commit comments

Comments
 (0)