Skip to content

Commit 70702aa

Browse files
Update CONTRIBUTING.md
1 parent 4f3446b commit 70702aa

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,17 @@ Before you begin, you'll need to install a few tools:
6666
bun install
6767
```
6868

69-
7. **Start development services** (requires 3 terminals):
69+
7. **Setup a Github OAuth app**
70+
71+
1. Follow these instructions to set up a [Github OAuth app](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app)
72+
2. Find your app's Github client ID and secret access key and set them in Infisical:
73+
74+
```bash
75+
infisical secrets set CODEBUFF_GITHUB_ID=<your-github-app-id-here>
76+
infisical secrets set CODEBUFF_GITHUB_SECRET=<your-github-app-secret-here>
77+
```
78+
79+
8. **Start development services** (requires 3 terminals):
7080

7181
```bash
7282
# Terminal 1 - Backend server (start first)
@@ -86,32 +96,23 @@ Before you begin, you'll need to install a few tools:
8696

8797
**Note**: CLI requires both backend and web server running for authentication.
8898

89-
8. **Giving yourself credits**:
90-
91-
There are two ways to give yourself credits:
99+
9. **Giving yourself credits**:
92100

93-
1. If you have the Stripe environment variables set, you can add billing information (just put in a fake credit card) at http://localhost:3000/usage
101+
1. Log into Codebuff at [http://localhost:3000/login](http://localhost:3000/login)
94102

95-
2. However, if you don't have Stripe set up, you will need to manually add credits to your account in the database.
103+
2. Then give yourself lots of credits. Be generous, you're the boss now!
96104

97105
```bash
98106
bun run start-studio
99107
```
100108

101109
Then, navigate to https://local.drizzle.studio/
102110

103-
Create a new row in the `credit_ledger` table. The values should be:
104-
105-
- `operation_id`: [anything you want should be unique]
106-
- `user_id`: [your user ID from the `user` table]
107-
- `principal`: [some very large number, one hundred million should last basically indefinitely]
108-
- `balance`: [the same as `principal`]
109-
- `type`: admin
110-
- `priority`: 80
111+
Edit your row in the `credit_ledger` table to set the `principal` to whatever you like and the `balance` to equal it.
111112

112113
Now, you should be able to run the CLI commands locally from within the `codebuff` directory.
113114

114-
9. **Running in other directories**:
115+
10. **Running in other directories**:
115116

116117
In order to run the CLI from other directories, you need to first publish the agents to the database.
117118

0 commit comments

Comments
 (0)