-
Notifications
You must be signed in to change notification settings - Fork 377
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add quick start example #25
Merged
Merged
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,4 +9,6 @@ dist-ssr | |
.cache | ||
server/dist | ||
public/dist | ||
.idea | ||
.idea | ||
.yarn | ||
.pnp.*js |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Development Environment | ||
|
||
Get a local development environment up and running with as few steps as possible. | ||
|
||
## Required Variables | ||
|
||
- **OPENAI_API_KEY:** [Get your GPT-4 OpenAI key](https://platform.openai.com/api-keys) | ||
|
||
## Start | ||
|
||
```shell | ||
yarn set version classic | ||
yarn install | ||
yarn contracts:solo-up | ||
yarn contracts:deploy:solo | ||
|
||
PORT=3000 \ | ||
ORIGIN="*" \ | ||
OPENAI_API_KEY="sk-proj-.." \ | ||
ADMIN_MNEMONIC="denial kitchen pet squirrel other broom bar gas better priority spoil cross" \ | ||
NETWORK_URL=http://localhost:8669 \ | ||
REWARD_AMOUNT=1 \ | ||
yarn dev | ||
``` | ||
|
||
## Result | ||
|
||
Link | Service | ||
--- | --- | ||
http://localhost:8082 | Frontend | ||
http://localhost:3000 | Backend | ||
http://localhost:8081 | Inspector | ||
http://localhost:8669 | Solo Thor | ||
|
||
Deployed contracts documented in: [packages/config-contract/config.ts](packages/config-contract/config.ts) | ||
|
||
## Shutdown | ||
|
||
```shell | ||
yarn contracts:solo-down | ||
``` |
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Like the idea of the quickstart! But
OPENAI_API_KEY="sk-proj-.."
would configure the backend with a wrong API keyUsers might mistake the steps as a copy and paste and everything will work.
Possible solution could be adding the "Result" section of the Quickstart below the Readme here: