StanGirard/quivr
1
1
Fork 0
mirror of https://github.com/StanGirard/quivr.git synced 2024-12-23 03:12:24 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix typo in name of docker compose dev file (#1800)

Browse Source 
# Description

fix typo in readme

## Checklist before requesting a review

Please delete options that are not relevant.

- [x] My code follows the style guidelines of this project
- [x] I have performed a self-review of my code
- [x] I have commented hard-to-understand areas
- [x] I have ideally added tests that prove my fix is effective or that
my feature works
- [x] New and existing unit tests pass locally with my changes
- [x] Any dependent changes have been merged
This commit is contained in:
Aditya Nandan 2023-12-03 19:50:36 +05:30 committed by GitHub
parent a5ef5a0454
commit 779b6647ef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -19,7 +19,7 @@ Quivr, your second brain, utilizes the power of GenerativeAI to be your personal
- **OS Compatible**: Ubuntu 22 or newer. - **OS Compatible**: Ubuntu 22 or newer.
- **File Compatibility**: Text, Markdown, PDF, Powerpoint, Excel, CSV, Word, Audio, Video - **File Compatibility**: Text, Markdown, PDF, Powerpoint, Excel, CSV, Word, Audio, Video
- **Open Source**: Freedom is beautiful, and so is Quivr. Open source and free to use. - **Open Source**: Freedom is beautiful, and so is Quivr. Open source and free to use.
- **Public/Private**: Share your brains with your users via a public link, or keep them private. - **Public/Private**: Share your brains with your users via a public link, or keep them private.
- **Marketplace**: Share your brains with the world, or use other people's brains to boost your productivity. - **Marketplace**: Share your brains with the world, or use other people's brains to boost your productivity.
- **Offline Mode**: Quivr works offline, so you can access your data anytime, anywhere. - **Offline Mode**: Quivr works offline, so you can access your data anytime, anywhere.
@ -27,7 +27,6 @@ Quivr, your second brain, utilizes the power of GenerativeAI to be your personal
https://github.com/StanGirard/quivr/assets/19614572/a6463b73-76c7-4bc0-978d-70562dca71f5 https://github.com/StanGirard/quivr/assets/19614572/a6463b73-76c7-4bc0-978d-70562dca71f5
## Getting Started 🚀 ## Getting Started 🚀
Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes. Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.
@ -41,7 +40,6 @@ Ensure you have the following installed:
- Docker - Docker
- Docker Compose - Docker Compose
### 60 seconds Installation 💽 ### 60 seconds Installation 💽
You can find the installation video [here](https://www.youtube.com/watch?v=cXBa6dZJN48). You can find the installation video [here](https://www.youtube.com/watch?v=cXBa6dZJN48).
@ -68,7 +66,6 @@ You can find the installation video [here](https://www.youtube.com/watch?v=cXBa6
You just need to update the `OPENAI_API_KEY` variable in the `.env` file. You can get your API key [here](https://platform.openai.com/api-keys). You need to create an account first. And put your credit card information. Don't worry, you won't be charged unless you use the API. You can find more information about the pricing [here](https://openai.com/pricing/). You just need to update the `OPENAI_API_KEY` variable in the `.env` file. You can get your API key [here](https://platform.openai.com/api-keys). You need to create an account first. And put your credit card information. Don't worry, you won't be charged unless you use the API. You can find more information about the pricing [here](https://openai.com/pricing/).
> Want to use [Ollama.ai](https://ollama.ai) instead? > Want to use [Ollama.ai](https://ollama.ai) instead?
> Uncomment the following lines in the `.env` file: > Uncomment the following lines in the `.env` file:
> OLLAMA_API_BASE_URL > OLLAMA_API_BASE_URL
@ -78,12 +75,12 @@ You can find the installation video [here](https://www.youtube.com/watch?v=cXBa6
- **Step 4**: Launch the project - **Step 4**: Launch the project
```bash ```bash
docker compose pull docker compose pull
docker compose up --build # if OPENAI docker compose up --build # if OPENAI
# docker compose -f docker-compose-ollama.yml up --build # Only if using Ollama. You need to run `ollama run llama2` first. # docker compose -f docker-compose-ollama.yml up --build # Only if using Ollama. You need to run `ollama run llama2` first.
``` ```
If you are a developer, you can run the project in development mode with the following command: `docker compose -f docker-compose-dev.yml up --build` If you are a developer, you can run the project in development mode with the following command: `docker compose -f docker-compose.dev.yml up --build`
- **Step 5**: Login to the app - **Step 5**: Login to the app
@ -91,12 +88,8 @@ You can find the installation video [here](https://www.youtube.com/watch?v=cXBa6
You can now sign in to the app with your new user. You can access the app at [http://localhost:3000/login](http://localhost:3000/login). You can now sign in to the app with your new user. You can access the app at [http://localhost:3000/login](http://localhost:3000/login).
You can access Quivr backend API at [http://localhost:5050/docs](http://localhost:5050/docs) You can access Quivr backend API at [http://localhost:5050/docs](http://localhost:5050/docs)
## Updating Quivr 🚀 ## Updating Quivr 🚀
- **Step 1**: Pull the latest changes - **Step 1**: Pull the latest changes