Skip to content
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.

Sign up for GitHub

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

added stuff to readme like wallet and resources #1

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

added stuff to readme like wallet and resources #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8e19bf
changed readme to mynearwallet and to cd into examples
codingshot Sep 4, 2024
d0790af
Merge branch 'main' of https://github.com/jbarnes850/near-ai-cookbook
codingshot Sep 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

package-lock.json
20 changes: 16 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ Before you begin, ensure you have the following installed:

You'll also need:

- A NEAR account. If you don't have one, you can create it using [NEAR Wallet](https://mynearwallet.com/).
- API keys for services used in the examples. Refer to the `.env.example` file for the required keys.
- A NEAR account. If you don't have one, you can create it using [NEAR Wallet](https://app.mynearwallet.com/). or [Testnet Wallet](https://testnet.mynearwallet.com)
- API keys for services used in the examples (e.g., [OpenAI](https://platform.openai.com/docs/quickstart), Pinecone). Refer to the `.env.example` file for the required keys.

## Installation

Expand All @@ -50,13 +50,18 @@ You'll also need:
git clone https://github.com/near/near-ai-cookbook.git
cd near-ai-cookbook
```
2. Navigate to /examples/examples repo
```
cd examples
cd <example-name>
```

2. Install dependencies:
3. Install dependencies:
```
npm install
```

3. Set up environment variables:
4. Set up environment variables:
- Copy `.env.example` to `.env.local`
- Fill in the required API keys and configuration values

Expand All @@ -76,6 +81,13 @@ We welcome contributions from the community! Whether it's adding new examples, i
## Resources

- [NEAR Documentation](https://docs.near.org/)
- [Hyperbolic Documentation](https://docs.hyperbolic.xyz/docs/getting-started) - decentralized inference
- [Yield Execution Contract](https://github.com/gagdiez/yield-resume) - build agents that can trigger responses based on external APIs
- [NEAR Simple Example App - Guestbook](https://github.com/near-examples/guest-book-examples)
## Ecosystem AI Examples
- [Bitte Agent Plugins](https://docs.mintbase.xyz/ai/assistant-plugins) - build an API to integrate on chain transactions into Bitte's AI Wallet
- [Indexer Agent](https://github.com/near/indexer-agent) - Example of generating idnexers based on transactions

- More resources to be added soon!

## License
Expand Down