chore: add a development explainer #930
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thedadams
requested review from
cjellick,
drpebcak,
ivyjeong13,
njhale,
StrongMonkey,
ryanhopperlowe and
g-linville
thedadams
force-pushed
the
development-md
branch
2 times, most recently
from
df66f62 to
b20c77f
Compare
| Now, any time one of these tools is run, your local copy will be used. | ||
|
|
||
| > [!IMPORTANT] | ||
| > Any time you change a Go based tool in your local repo, you must run `make build` in the tools repo for the changes to take effect with Obot. |
There was a problem hiding this comment.
Well I usually only build that binary specifically for the tool I care instead of building all of it.
StrongMonkey
approved these changes
Dec 17, 2024
drpebcak
approved these changes
Dec 17, 2024
g-linville
approved these changes
Dec 18, 2024
DEVELOPMENT.md
Outdated
|
|
||
| ## Debugging Obot | ||
|
|
||
| It is possible to run the server and/or UIs in and IDE for debugging purposes. These steps layout what is necessary for Jet Brains IDEs, but an equivalent process can be used with VSCode based editors. |
There was a problem hiding this comment.
tiny nits
Suggested change
| It is possible to run the server and/or UIs in and IDE for debugging purposes. These steps layout what is necessary for Jet Brains IDEs, but an equivalent process can be used with VSCode based editors. | |
| It is possible to run the server and/or UIs in and IDE for debugging purposes. These steps layout what is necessary for JetBrains IDEs, but an equivalent process can be used with VSCode-based editors. |
DEVELOPMENT.md
Outdated
|
|
||
| ### Admin UI | ||
|
|
||
| To run the Admin UI in GoLand or Web Storm: |
There was a problem hiding this comment.
tiny nit:
Suggested change
| To run the Admin UI in GoLand or Web Storm: | |
| To run the Admin UI in GoLand or WebStorm: |
DEVELOPMENT.md
Outdated
|
|
||
| ### User UI | ||
|
|
||
| To run the User UI in GoLand or Web Storm: |
There was a problem hiding this comment.
tiny nit:
Suggested change
| To run the User UI in GoLand or Web Storm: | |
| To run the User UI in GoLand or WebStorm: |
DEVELOPMENT.md
Outdated
|
|
||
| ## Obot Credentials | ||
|
|
||
| The GPTScript credentials for Obot are, by default, store in an SQLite database called `obot-credentials.db` in the root of the obot repo. You can use the `sqlite3` CLI to inspect the database directly: `sqlite3 obot-credentials.db`. |
There was a problem hiding this comment.
Suggested change
| The GPTScript credentials for Obot are, by default, store in an SQLite database called `obot-credentials.db` in the root of the obot repo. You can use the `sqlite3` CLI to inspect the database directly: `sqlite3 obot-credentials.db`. | |
| The GPTScript credentials for Obot are, by default, stored in a SQLite database called `obot-credentials.db` in the root of the obot repo. You can use the `sqlite3` CLI to inspect the database directly: `sqlite3 obot-credentials.db`. |
I know it's probably technically pronounced "S Q lite", but I'm pretty sure most people just say "sequelite".
thedadams
commented
Dec 18, 2024
.github/workflows/docker-build.yml
Outdated
| - name: Setup Depot | ||
| uses: depot/setup-action@v1 | ||
|
|
||
| - name: Build and push Docker image |
There was a problem hiding this comment.
Note for myself to fix this
Suggested change
| - name: Build and push Docker image | |
| - name: Build Docker Image |
thedadams
force-pushed
the
development-md
branch
from
b20c77f to
0d87b51
Compare
This change also adds a docker build step to CI and adds the http/ directory to the gitignore. Signed-off-by: Donnie Adams <[email protected]>
thedadams
force-pushed
the
development-md
branch
from
0d87b51 to
6a5adc8
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change also adds a docker build step to CI and adds the http/ directory to the gitignore.
Issue: #909