Chore(wren-ui): update wren-ui readme #534
Merged
Conversation
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
fredalai
reviewed
Jul 18, 2024
| We currently do not support multiple projects in Wren AI. You can only have one project at a time. | ||
| But there is a workaround for this. Since Wren Engine is stateless and we store your semantic model in the database(Sqlite or Postgres), | ||
| you can switch between projects by switching the database and make sure you deploying after server started. | ||
|
|
There was a problem hiding this comment.
(NIT) Suggestion:
Add a tip to describe a brief description - the key point is to use the SQLITE_FILE variable to change the DB
> Tip: Define the `SQLITE_FILE` variable to specify the path to the database you intend to use.
fredalai
reviewed
Jul 18, 2024
| export SQLITE_FILE={your_sqlite_file_path} | ||
| ``` | ||
|
|
||
| Step 4. Run migrations: |
There was a problem hiding this comment.
Update Step 4. Run the development server: to Step 5. Run the development server:
wren-ui/README.md
Outdated
Comment on lines
16
to
17
| Step 3(Optional). Switching database | ||
| Wren-ui use sqlite as our default database. To use Postgres as the database of wren-ui, you need to set the two environment variable below. |
There was a problem hiding this comment.
Suggested change
| Step 3(Optional). Switching database | |
| Wren-ui use sqlite as our default database. To use Postgres as the database of wren-ui, you need to set the two environment variable below. | |
| Step 3(Optional). Switching database | |
| Wren-ui uses SQLite as our default database. To use Postgres as the database of wren-ui, you need to set the two environment variables below. |
wren-ui/README.md
Outdated
| @@ -32,6 +25,27 @@ SET PG_URL=postgres://user:password@localhost:5432/dbname | |||
| export DB_TYPE=pg | |||
| export PG_URL=postgres://user:password@localhost:5432/dbname | |||
| ``` | |||
| - PG_URL is the connection string of your postgres database. | |||
There was a problem hiding this comment.
Suggested change
| - PG_URL is the connection string of your postgres database. | |
| - `PG_URL` is the connection string of your postgres database. |
wren-ui/README.md
Outdated
| @@ -32,6 +25,27 @@ SET PG_URL=postgres://user:password@localhost:5432/dbname | |||
| export DB_TYPE=pg | |||
| export PG_URL=postgres://user:password@localhost:5432/dbname | |||
| ``` | |||
| - PG_URL is the connection string of your postgres database. | |||
|
|
|||
| To set back to sqlite, you can remove the two environment variables above. | |||
There was a problem hiding this comment.
I think we use SQLite better than sqlite
wren-ui/README.md
Outdated
| Step 1. Prepare you .env file | ||
| In the WrenAI/docker folder, you can find the .env.example file. You can copy this file to .env.local file. | ||
|
|
||
| ``` |
There was a problem hiding this comment.
(NIT) Suggestion: add bash for all ``` if suitable.
Suggested change
| ``` | |
| ```bash |
| refer to [Start wren-ui from source code](#Start-wren-ui-from-source-code) section to start wren-ui from source code. | ||
|
|
||
| Step 5. (Optional) Develop other modules along with wren-ui | ||
| As mentioned above, you can use docker-compose to start other modules. The same applies when developing other modules. |
There was a problem hiding this comment.
Add an extra blank line if you want it to wrap.
So are other places.
wren-ui/README.md
Outdated
| Step 5. (Optional) Develop other modules along with wren-ui | ||
| As mentioned above, you can use docker-compose to start other modules. The same applies when developing other modules. | ||
| From the perspective of wren-ui, if you want to develop other modules at the same time, you can stop the container then spin up the module from the source code. | ||
| Refer to the README.md or CONTRIBUTION.md file the module for starting the module from the source code. |
There was a problem hiding this comment.
For README.md and CONTRIBUTION.md, do we have a link to provide?
inductor69
approved these changes
Sep 4, 2024
wwwy3y3
force-pushed
the
chore/ui-readme
branch
from
20cc6d7
to
ab08176
Compare
wwwy3y3
approved these changes
Oct 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Provide local setup instruction and FAQ