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

Updated Readme file and Added Missing Env Variables #72

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+16 −13
Open

Updated Readme file and Added Missing Env Variables #72

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
17bcd8e
Updated Readme and .env.sample
AbhishekJha-45 Jan 13, 2025
a008108
Updated Readme and .env.sample
AbhishekJha-45 Jan 13, 2025
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
3 changes: 3 additions & 0 deletions .example.env
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
#Mandatory Api Keys
TOGETHER_API_KEY=
DATABASE_URL=
CSB_API_KEY=

# Optional, if you want observability
HELICONE_API_KEY=
26 changes: 13 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,7 @@
<a href="https://www.llamacoder.io">
<img alt="Llama Coder" src="./public/og-image.png">
<h1 align="center">Llama Coder</h1>
</a>

<p align="center">
An open source Claude Artifacts – generate small apps with one prompt. Powered by Llama 3 on Together.ai.
</p>

## Tech stack

- [Llama 3.1 405B](https://ai.meta.com/blog/meta-llama-3-1/) from Meta for the LLM
- [Together AI](https://dub.sh/together-ai/?utm_source=example-app&utm_medium=llamacoder&utm_campaign=llamacoder-app-signup) for LLM inference
- [Together AI](https://dub.sh/together-ai/?utm_source=example-app\&utm_medium=llamacoder\&utm_campaign=llamacoder-app-signup) for LLM inference
- [Sandpack](https://sandpack.codesandbox.io/) for the code sandbox
- Next.js app router with Tailwind
- Helicone for observability
Expand All @@ -19,9 +10,18 @@
## Cloning & running

1. Clone the repo: `git clone https://github.com/Nutlope/llamacoder`
2. Create a `.env` file and add your [Together AI API key](https://dub.sh/together-ai/?utm_source=example-app&utm_medium=llamacoder&utm_campaign=llamacoder-app-signup): `TOGETHER_API_KEY=`
3. Run `npm install` and `npm run dev` to install dependencies and run locally

2. Create a `.env` file and add your API keys:

- **[Together AI API key](https://dub.sh/together-ai/?utm_source=example-app\&utm_medium=llamacoder\&utm_campaign=llamacoder-app-signup)**: `TOGETHER_API_KEY=<your_together_ai_api_key>`
- **[CSB API key](https://codesandbox.io/signin)**: `CSB_API_KEY=<your_csb_api_key>`
- **Database URL**: Use [Neon](https://neon.tech) to set up your PostgreSQL database and add the Prisma connection string: `DATABASE_URL=<your_database_url>`

3. Run `npm install` to install dependencies.

4. Run `npm run dev` to start the development server locally.

## Contributing

For contributing to the repo, please see the [contributing guide](./CONTRIBUTING.md)
For contributing to the repo, please see the [contributing guide](./CONTRIBUTING.md).