Skip to content

Commit

Permalink
Update readme and add fixtures
Browse files Browse the repository at this point in the history
  • Loading branch information
ajhai committed Sep 18, 2023
1 parent c1619d4 commit 4c95b02
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 8 deletions.
28 changes: 23 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<a href="https://llmstack.ai"><img src="web/static/img/llmstack-logo-light-white-bg.svg" alt="LLMStack" width="500px"></a>
<a href="https://llmstack.ai"><img src="https://llmstack.ai/img/llmstack-logo-light-white-bg.svg" alt="LLMStack" width="500px"></a>
</p>
<p align="center">
<em>LLMStack is a no-code platform for building generative AI applications, chatbots, agents and connecting them to your data and business processes.</em>
Expand All @@ -12,8 +12,8 @@

Build tailor-made generative AI applications, chatbots and agents that cater to your unique needs by chaining multiple LLMs. Seamlessly integrate your own data and GPT-powered models without any coding experience using LLMStack's no-code builder. Trigger your AI chains from Slack or Discord. Deploy to the cloud or on-premise.


![llmstack-quickstart](https://github.com/trypromptly/LLMStack/assets/431988/72de45f5-23f9-4cd3-91b0-7d5ae97534c3)

<p align="center">
<em>See full demo video <a href="https://youtu.be/8icy1Ccs2lk" target="_blank">here</a></em>
</p>
Expand All @@ -22,7 +22,27 @@ Build tailor-made generative AI applications, chatbots and agents that cater to

**_Check out our Cloud offering at [Promptly](https://trypromptly.com) or follow the instructions below to deploy LLMStack on your own infrastructure._**

Clone this repository or download the latest release. Install [docker](https://docs.docker.com/engine/install/) if not already installed. Copy `.env.prod` to `.env` and update `SECRET_KEY`, `CIPHER_SALT` and `DATABASE_PASSWORD` in `.env` file:
LLMStack deployment comes with a default admin account whose credentials are `admin` and `promptly`. _Be sure to change the password from admin panel after logging in_.

### Option 1

Install LLMStack using pip:

```sh
pip install llmstack
```

Start LLMStack using the following command:

```sh
llmstack
```

Above commands will install and start LLMStack. It will create `.llmstack` in your home directory and places the database and config files in it when run for the first time. Once LLMStack is up and running, it should automatically open your browser and point it to [localhost:3000](http://localhost:3000).

### Option 2

This method uses docker compose to bring up the application containers. Clone this repository or download the latest release. Install [docker](https://docs.docker.com/engine/install/) if not already installed. Copy `.env.prod` to `.env` and update `SECRET_KEY`, `CIPHER_SALT` and `DATABASE_PASSWORD` in `.env` file:

```
cp .env.prod .env
Expand All @@ -38,8 +58,6 @@ Run LLMStack using the following command:
Once LLMStack is up and ready, it should automatically open your browser and point it to [localhost:3000](http://localhost:3000). You can also alternatively use `docker compose up` to manually start the containers and open [localhost:3000](http://localhost:3000) to login into the platform. Make sure to wait for the API server to be ready before trying to load LLMStack.

LLMStack deployment comes with a default admin account whose credentials are `admin` and `promptly`. _Be sure to change the password from admin panel after logging in_.

> Users of the platform can add their own keys to providers like OpenAI, Cohere, Stability etc., from Settings page. If you want to provide default keys for all the users of your LLMStack instance, you can add them to the `.env` file. Make sure to restart the containers after adding the keys.
> Remember to update `POSTGRES_VOLUME`, `REDIS_VOLUME` and `WEAVIATE_VOLUME` in `.env` file if you want to persist data across container restarts.
Expand Down
11 changes: 9 additions & 2 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ include = [
"client/build/static/images/*",
"client/build/static/js/*",
"client/build/static/media/*",
"fixtures/*",
"static/*",
]
packages = [
Expand All @@ -33,7 +34,7 @@ packages = [
llmstack = "llmstack.cli:main"

[tool.poetry.dependencies]
python = "^3.11"
python = "^3.9"
aiohttp = {version = "3.8.4", allow-prereleases = true}
aiosignal = {version = "1.3.1", allow-prereleases = true}
anyio = {version = "3.6.2", allow-prereleases = true}
Expand Down

0 comments on commit 4c95b02

Please sign in to comment.