Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
carlbrn committed Oct 31, 2024
1 parent 38873b9 commit 4a159ae
Showing 1 changed file with 16 additions and 13 deletions.
29 changes: 16 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,37 @@
![Weacle Speed Example](https://weacle.nyc3.cdn.digitaloceanspaces.com/static/github/weacle-speed-example-1.webp)
![Weacle Speed Example](https://weacle.nyc3.cdn.digitaloceanspaces.com/static/github/weacle-speed-example-2-1500x921.webp)

# Weacle Speed

An open-source AI app to help you code faster.
An open-source AI powered app to help code faster.
Ask an LLM to do some work with your files.

1. Select the files and directories to include in your prompt.
2. Write the prompt.
2. Write a prompt.

## Get started

1. Download the project
2. At the root of the repo, create an `.env` file with the following variables and specify the desired ports:
```
SERVER_PORT=4300
SERVER_WATCHER_PORT=4302
VITE_CLIENT_PORT=4301
VITE_SERVER_PORT=4300
```
In `speed/server/node`, create an `.env` file with the following variables:
```
OPENAI_API_KEY
ANTHROPIC_API_KEY
MONGODB_URI
OPENAI_API_KEY
PINECONE_API_KEY
PINECONE_INDEX_NAME
```
3. Start the client by running the command `yarn dev-client`
4. Start the server with `yarn dev-server`
5. Open the client page in your browser and set the system prompt. Learn more in the System Prompt section.
6. Add the project directory path, press `enter`.
7. In the settings, specify the files and paths to include and exclude.
8. The directory panel should list folders and files. Select the ones you want to include in the prompt.
4. Start the server with `yarn dev-server`, and the watcher with `yarn dev-watcher`
5. Open the client page in your browser and create a new project.
6. Set the system prompt. Learn more in the System Prompt section.
7. In the settings, specify the files and paths to include or exclude. You can initiate file indexing from the settings, it will be used for the file search.
8. The directory panel should list the project folders and files. Select the ones you want to include in the prompt.
9. Type your prompt, send it, enjoy!

## Example of system prompt
Expand Down Expand Up @@ -56,12 +60,11 @@ The client code uses react, nextjs, zod in typescript.
## Tech Stack
The project uses:
- Yarn 4 ([how to install](https://yarnpkg.com/getting-started/install))
- Node server, ViteJs + React
- NodeJs, ViteJs, React
- MongoDB, Pinecone, OpenAI, Anthropics API

## About the models used
Models used are `claude-3-5-sonnet-20240620`(default), `gpt-4o-2024-08-06` and `gpt-4o-mini`.
The temperature is 0.
Max token is 4096.
Models used are `claude-3-5-sonnet`(default), `gpt-4o` and `gpt-4o-mini`.

## Author
• Carl Brenner [@carlbrn](https://github.com/carlbrn)
Expand Down

0 comments on commit 4a159ae

Please sign in to comment.