mirror of
https://github.com/QuivrHQ/quivr.git
synced 2024-12-14 17:03:29 +03:00
be9dfe25fd
# Description Please include a summary of the changes and the related issue. Please also include relevant motivation and context. ## Checklist before requesting a review Please delete options that are not relevant. - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my code - [ ] I have commented hard-to-understand areas - [ ] I have ideally added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged ## Screenshots (if appropriate):
161 lines
5.8 KiB
Markdown
161 lines
5.8 KiB
Markdown
# Quivr - Your Second Brain, Empowered by Generative AI
|
|
|
|
<div align="center">
|
|
<img src="./logo.png" alt="Quivr-logo" width="31%" style="border-radius: 50%; padding-bottom: 20px"/>
|
|
</div>
|
|
|
|
[](https://discord.gg/HUpRgp2HG8)
|
|
[](https://github.com/quivrhq/quivr)
|
|
[](https://twitter.com/_StanGirard)
|
|
|
|
Quivr, your second brain, utilizes the power of GenerativeAI to be your personal assistant ! Think of it as Obsidian, but turbocharged with AI capabilities.
|
|
|
|
[Roadmap here](https://docs.quivr.app/docs/roadmap)
|
|
|
|
## Key Features 🎯
|
|
|
|
- **Fast and Efficient**: Designed with speed and efficiency at its core. Quivr ensures rapid access to your data.
|
|
- **Secure**: Your data, your control. Always.
|
|
- **OS Compatible**: Ubuntu 20 or newer.
|
|
- **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.
|
|
- **Public/Private**: Share your brains with your users via a public link, or keep them private.
|
|
- **Offline Mode**: Quivr works offline, so you can access your data anytime, anywhere.
|
|
|
|
## Demo Highlight 🎥
|
|
|
|
https://github.com/quivrhq/quivr/assets/19614572/a6463b73-76c7-4bc0-978d-70562dca71f5
|
|
|
|
## Getting Started 🚀
|
|
|
|
You can deploy Quivr to Porter Cloud with one-click:
|
|
|
|
<a href="https://cloud.porter.run/addons/new?addon_name=quivr" target="_blank">
|
|
<img src="https://mintlify.s3-us-west-1.amazonaws.com/porter/images/deploying-applications/deploy-to-porter.svg" alt="Deploy to Porter" style="width: 150px;">
|
|
</a>
|
|
|
|
|
|
If you would like to deploy locally, follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.
|
|
|
|
You can find everything on the [documentation](https://docs.quivr.app/).
|
|
|
|
### Prerequisites 📋
|
|
|
|
Ensure you have the following installed:
|
|
|
|
- Docker
|
|
- Docker Compose
|
|
|
|
### 60 seconds Installation 💽
|
|
|
|
You can find the installation video [here](https://www.youtube.com/watch?v=cXBa6dZJN48).
|
|
|
|
- **Step 0**: Supabase CLI
|
|
|
|
Follow the instructions [here](https://supabase.com/docs/guides/cli/getting-started) to install the Supabase CLI that is required.
|
|
|
|
```bash
|
|
supabase -v # Check that the installation worked
|
|
```
|
|
|
|
|
|
- **Step 1**: Clone the repository:
|
|
|
|
```bash
|
|
git clone https://github.com/quivrhq/quivr.git && cd quivr
|
|
```
|
|
|
|
- **Step 2**: Copy the `.env.example` files
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
```
|
|
|
|
- **Step 3**: Update the `.env` files
|
|
|
|
```bash
|
|
vim .env # or emacs or vscode or nano
|
|
```
|
|
|
|
Update **OPENAI_API_KEY** in the `.env` file.
|
|
|
|
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/).
|
|
|
|
|
|
- **Step 4**: Launch the project
|
|
|
|
```bash
|
|
cd backend && supabase start
|
|
```
|
|
and then
|
|
```bash
|
|
cd ../
|
|
docker compose pull
|
|
docker compose up
|
|
```
|
|
|
|
If you have a Mac, go to Docker Desktop > Settings > General and check that the "file sharing implementation" is set to `VirtioFS`.
|
|
|
|
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
|
|
|
|
You can now sign in to the app with `admin@quivr.app` & `admin`. 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 supabase at [http://localhost:54323](http://localhost:54323)
|
|
|
|
## Updating Quivr 🚀
|
|
|
|
- **Step 1**: Pull the latest changes
|
|
|
|
```bash
|
|
git pull
|
|
```
|
|
|
|
- **Step 2**: Update the migration
|
|
|
|
```bash
|
|
supabase migration up
|
|
```
|
|
|
|
|
|
## Contributors ✨
|
|
|
|
Thanks go to these wonderful people:
|
|
<a href="https://github.com/quivrhq/quivr/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=quivrhq/quivr" />
|
|
</a>
|
|
|
|
## Contribute 🤝
|
|
|
|
Did you get a pull request? Open it, and we'll review it as soon as possible. Check out our project board [here](https://github.com/users/StanGirard/projects/5) to see what we're currently focused on, and feel free to bring your fresh ideas to the table!
|
|
|
|
- [Open Issues](https://github.com/quivrhq/quivr/issues)
|
|
- [Open Pull Requests](https://github.com/quivrhq/quivr/pulls)
|
|
- [Good First Issues](https://github.com/quivrhq/quivr/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
|
|
- [Frontend Issues](https://github.com/quivrhq/quivr/issues?q=is%3Aopen+is%3Aissue+label%3Afrontend)
|
|
- [Backend Issues](https://github.com/quivrhq/quivr/issues?q=is%3Aopen+is%3Aissue+label%3Abackend)
|
|
- [Translate](https://docs.quivr.app/docs/Developers/contribution/guidelines#translations)
|
|
|
|
## Partners ❤️
|
|
|
|
This project would not be possible without the support of our partners. Thank you for your support!
|
|
|
|
|
|
<a href="https://ycombinator.com/">
|
|
<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/b/b2/Y_Combinator_logo.svg/1200px-Y_Combinator_logo.svg.png" alt="YCombinator" style="padding: 10px" width="70px">
|
|
</a>
|
|
<a href="https://www.theodo.fr/">
|
|
<img src="https://avatars.githubusercontent.com/u/332041?s=200&v=4" alt="Theodo" style="padding: 10px" width="70px">
|
|
</a>
|
|
|
|
## License 📄
|
|
|
|
This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details
|
|
|
|
## Stars History 📈
|
|
|
|
[](https://star-history.com/#quivrhq/quivr&Timeline)
|