diff --git a/.github/workflows/aws-preview.yml b/.github/workflows/aws-preview.yml index abc0d9687..b0d8e08c2 100644 --- a/.github/workflows/aws-preview.yml +++ b/.github/workflows/aws-preview.yml @@ -2,9 +2,9 @@ name: Deploy Backend to Preview ECS on: push: - branches: [ "main" ] + branches: ["main"] paths: - - 'backend/**' + - "backend/**" env: AWS_REGION: eu-west-3 @@ -19,58 +19,56 @@ jobs: environment: production steps: - - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 + - name: Checkout + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 - - name: Configure AWS credentials - uses: aws-actions/configure-aws-credentials@5fd3084fc36e372ff1fff382a39b10d03659f355 # v2 - with: - aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} - aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} - aws-region: ${{ env.AWS_REGION }} + - name: Configure AWS credentials + uses: aws-actions/configure-aws-credentials@5fd3084fc36e372ff1fff382a39b10d03659f355 # v2 + with: + aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} + aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} + aws-region: ${{ env.AWS_REGION }} + + - name: Login to Amazon ECR + id: login-ecr + uses: aws-actions/amazon-ecr-login@2fc7aceee09e9e4a7105c0d060c656fad0b4f63d # v1 + + - name: Login to GitHub Container Registry + uses: docker/login-action@465a07811f14bebb1938fbed4728c6a1ff8901fc # v2 + with: + registry: ghcr.io + username: ${{ github.repository_owner }} + password: ${{ secrets.GITHUB_TOKEN }} + - name: Login to Docker Hub + uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3 + with: + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_TOKEN }} + + - uses: docker/setup-qemu-action@68827325e0b33c7199eb31dd4e31fbe9023e06e3 # v3 + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@f95db51fddba0c2d1ec667646a06c2ce06100226 # v3 + + - name: Create Docker Cacha Storage Backend + run: | + docker buildx create --use --driver=docker-container + - name: See the file in the runner + run: | + ls -la + - name: Build, tag, and push image to Amazon ECR + id: build-image + uses: docker/build-push-action@4a13e500e55cf31b7a5d59a38ab2040ab0f42f56 # v5 + env: + ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }} + IMAGE_TAG: ${{ github.sha }} + with: + context: ./backend/ + push: true + platforms: linux/amd64,linux/arm64 + tags: ${{ env.ECR_REGISTRY }}/${{ env.ECR_REPOSITORY }}:${{ env.IMAGE_TAG }}, ${{ env.ECR_REGISTRY }}/${{ env.ECR_REPOSITORY }}:latest, ghcr.io/QuivrHQ/quivr:latest, QuivrHQ/quivr-backend-prebuilt:latest, QuivrHQ/quivr-backend-prebuilt:${{ env.IMAGE_TAG }} + cache-from: type=gha + cache-to: type=gha,mode=max - - name: Login to Amazon ECR - id: login-ecr - uses: aws-actions/amazon-ecr-login@2fc7aceee09e9e4a7105c0d060c656fad0b4f63d # v1 - - - name: Login to GitHub Container Registry - uses: docker/login-action@465a07811f14bebb1938fbed4728c6a1ff8901fc # v2 - with: - registry: ghcr.io - username: ${{ github.repository_owner }} - password: ${{ secrets.GITHUB_TOKEN }} - - name: Login to Docker Hub - uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3 - with: - username: ${{ secrets.DOCKERHUB_USERNAME }} - password: ${{ secrets.DOCKERHUB_TOKEN }} - - - uses: docker/setup-qemu-action@68827325e0b33c7199eb31dd4e31fbe9023e06e3 # v3 - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@f95db51fddba0c2d1ec667646a06c2ce06100226 # v3 - - - name: Create Docker Cacha Storage Backend - run: | - docker buildx create --use --driver=docker-container - - name: See the file in the runner - run: | - ls -la - - name: Build, tag, and push image to Amazon ECR - id: build-image - uses: docker/build-push-action@4a13e500e55cf31b7a5d59a38ab2040ab0f42f56 # v5 - env: - ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }} - IMAGE_TAG: ${{ github.sha }} - with: - context: ./backend/ - push: true - platforms: linux/amd64,linux/arm64 - tags: ${{ env.ECR_REGISTRY }}/${{ env.ECR_REPOSITORY }}:${{ env.IMAGE_TAG }}, ${{ env.ECR_REGISTRY }}/${{ env.ECR_REPOSITORY }}:latest, ghcr.io/stangirard/quivr:latest, stangirard/quivr-backend-prebuilt:latest, stangirard/quivr-backend-prebuilt:${{ env.IMAGE_TAG }} - cache-from: type=gha - cache-to: type=gha,mode=max - - - deploy: needs: build_and_push runs-on: ubuntu-latest @@ -89,28 +87,28 @@ jobs: container: "quivr-chat" steps: - - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 - - - name: Configure AWS credentials - uses: aws-actions/configure-aws-credentials@5fd3084fc36e372ff1fff382a39b10d03659f355 # v2 - with: - aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} - aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} - aws-region: ${{ env.AWS_REGION }} + - name: Checkout + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 - - name: Fill in the new image ID in the Amazon ECS task definition for ${{ matrix.name }} - id: task-def - uses: aws-actions/amazon-ecs-render-task-definition@4225e0b507142a2e432b018bc3ccb728559b437a # v1 - with: - task-definition: ${{ matrix.task_definition }} - container-name: ${{ matrix.container }} - image: ${{env.ECR_REGISTRY}}/${{ env.ECR_REPOSITORY }}:${{ github.sha }} + - name: Configure AWS credentials + uses: aws-actions/configure-aws-credentials@5fd3084fc36e372ff1fff382a39b10d03659f355 # v2 + with: + aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} + aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} + aws-region: ${{ env.AWS_REGION }} - - name: Deploy Amazon ECS task definition for ${{ matrix.name }} - uses: aws-actions/amazon-ecs-deploy-task-definition@df9643053eda01f169e64a0e60233aacca83799a # v1 - with: - task-definition: ${{ steps.task-def.outputs.task-definition }} - service: ${{ matrix.service }} - cluster: ${{ env.ECS_CLUSTER }} - wait-for-service-stability: true \ No newline at end of file + - name: Fill in the new image ID in the Amazon ECS task definition for ${{ matrix.name }} + id: task-def + uses: aws-actions/amazon-ecs-render-task-definition@4225e0b507142a2e432b018bc3ccb728559b437a # v1 + with: + task-definition: ${{ matrix.task_definition }} + container-name: ${{ matrix.container }} + image: ${{env.ECR_REGISTRY}}/${{ env.ECR_REPOSITORY }}:${{ github.sha }} + + - name: Deploy Amazon ECS task definition for ${{ matrix.name }} + uses: aws-actions/amazon-ecs-deploy-task-definition@df9643053eda01f169e64a0e60233aacca83799a # v1 + with: + task-definition: ${{ steps.task-def.outputs.task-definition }} + service: ${{ matrix.service }} + cluster: ${{ env.ECS_CLUSTER }} + wait-for-service-stability: true diff --git a/.github/workflows/aws-strapi.yml b/.github/workflows/aws-strapi.yml index 21dfd8526..954f1a9b2 100644 --- a/.github/workflows/aws-strapi.yml +++ b/.github/workflows/aws-strapi.yml @@ -2,9 +2,9 @@ name: Deploy Strapi on: push: - branches: [ "main" ] + branches: ["main"] paths: - - 'cms/**' + - "cms/**" env: AWS_REGION: eu-west-3 @@ -19,49 +19,49 @@ jobs: environment: production steps: - - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 + - name: Checkout + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 - - name: Configure AWS credentials - uses: aws-actions/configure-aws-credentials@5fd3084fc36e372ff1fff382a39b10d03659f355 # v2 - with: - aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} - aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} - aws-region: ${{ env.AWS_REGION }} + - name: Configure AWS credentials + uses: aws-actions/configure-aws-credentials@5fd3084fc36e372ff1fff382a39b10d03659f355 # v2 + with: + aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} + aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} + aws-region: ${{ env.AWS_REGION }} + + - name: Login to Amazon ECR + id: login-ecr + uses: aws-actions/amazon-ecr-login@2fc7aceee09e9e4a7105c0d060c656fad0b4f63d # v1 + + - name: Login to GitHub Container Registry + uses: docker/login-action@465a07811f14bebb1938fbed4728c6a1ff8901fc # v2 + with: + registry: ghcr.io + username: ${{ github.repository_owner }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@885d1462b80bc1c1c7f0b00334ad271f09369c55 # v2 + + - name: Create Docker Cacha Storage Backend + run: | + docker buildx create --use --driver=docker-container + - name: See the file in the runner + run: | + ls -la + - name: Build, tag, and push image to Amazon ECR + id: build-image + uses: docker/build-push-action@0a97817b6ade9f46837855d676c4cca3a2471fc9 # v4 + env: + ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }} + IMAGE_TAG: ${{ github.sha }} + with: + context: ./cms/quivr/ + push: true + tags: ${{ env.ECR_REGISTRY }}/${{ env.ECR_REPOSITORY }}:${{ env.IMAGE_TAG }}, ${{ env.ECR_REGISTRY }}/${{ env.ECR_REPOSITORY }}:latest, ghcr.io/QuivrHQ/quivr:latest + cache-from: type=gha + cache-to: type=gha,mode=max - - name: Login to Amazon ECR - id: login-ecr - uses: aws-actions/amazon-ecr-login@2fc7aceee09e9e4a7105c0d060c656fad0b4f63d # v1 - - - name: Login to GitHub Container Registry - uses: docker/login-action@465a07811f14bebb1938fbed4728c6a1ff8901fc # v2 - with: - registry: ghcr.io - username: ${{ github.repository_owner }} - password: ${{ secrets.GITHUB_TOKEN }} - - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@885d1462b80bc1c1c7f0b00334ad271f09369c55 # v2 - - - name: Create Docker Cacha Storage Backend - run: | - docker buildx create --use --driver=docker-container - - name: See the file in the runner - run: | - ls -la - - name: Build, tag, and push image to Amazon ECR - id: build-image - uses: docker/build-push-action@0a97817b6ade9f46837855d676c4cca3a2471fc9 # v4 - env: - ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }} - IMAGE_TAG: ${{ github.sha }} - with: - context: ./cms/quivr/ - push: true - tags: ${{ env.ECR_REGISTRY }}/${{ env.ECR_REPOSITORY }}:${{ env.IMAGE_TAG }}, ${{ env.ECR_REGISTRY }}/${{ env.ECR_REPOSITORY }}:latest, ghcr.io/stangirard/quivr:latest - cache-from: type=gha - cache-to: type=gha,mode=max - deploy: needs: build_and_push runs-on: ubuntu-latest @@ -76,28 +76,28 @@ jobs: container: "strapi" steps: - - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 - - - name: Configure AWS credentials - uses: aws-actions/configure-aws-credentials@5fd3084fc36e372ff1fff382a39b10d03659f355 # v2 - with: - aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} - aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} - aws-region: ${{ env.AWS_REGION }} + - name: Checkout + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 - - name: Fill in the new image ID in the Amazon ECS task definition for ${{ matrix.name }} - id: task-def - uses: aws-actions/amazon-ecs-render-task-definition@4225e0b507142a2e432b018bc3ccb728559b437a # v1 - with: - task-definition: ${{ matrix.task_definition }} - container-name: ${{ matrix.container }} - image: ${{env.ECR_REGISTRY}}/${{ env.ECR_REPOSITORY }}:${{ github.sha }} + - name: Configure AWS credentials + uses: aws-actions/configure-aws-credentials@5fd3084fc36e372ff1fff382a39b10d03659f355 # v2 + with: + aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} + aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} + aws-region: ${{ env.AWS_REGION }} - - name: Deploy Amazon ECS task definition for ${{ matrix.name }} - uses: aws-actions/amazon-ecs-deploy-task-definition@df9643053eda01f169e64a0e60233aacca83799a # v1 - with: - task-definition: ${{ steps.task-def.outputs.task-definition }} - service: ${{ matrix.service }} - cluster: ${{ env.ECS_CLUSTER }} - wait-for-service-stability: true \ No newline at end of file + - name: Fill in the new image ID in the Amazon ECS task definition for ${{ matrix.name }} + id: task-def + uses: aws-actions/amazon-ecs-render-task-definition@4225e0b507142a2e432b018bc3ccb728559b437a # v1 + with: + task-definition: ${{ matrix.task_definition }} + container-name: ${{ matrix.container }} + image: ${{env.ECR_REGISTRY}}/${{ env.ECR_REPOSITORY }}:${{ github.sha }} + + - name: Deploy Amazon ECS task definition for ${{ matrix.name }} + uses: aws-actions/amazon-ecs-deploy-task-definition@df9643053eda01f169e64a0e60233aacca83799a # v1 + with: + task-definition: ${{ steps.task-def.outputs.task-definition }} + service: ${{ matrix.service }} + cluster: ${{ env.ECS_CLUSTER }} + wait-for-service-stability: true diff --git a/.github/workflows/aws.yml b/.github/workflows/aws.yml index c4520270d..2aa374733 100644 --- a/.github/workflows/aws.yml +++ b/.github/workflows/aws.yml @@ -1,9 +1,9 @@ name: Deploy to Amazon ECS -on: +on: push: tags: - - 'v*' + - "v*" env: AWS_REGION: eu-west-3 @@ -18,49 +18,49 @@ jobs: environment: production steps: - - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 + - name: Checkout + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 - - name: Configure AWS credentials - uses: aws-actions/configure-aws-credentials@5fd3084fc36e372ff1fff382a39b10d03659f355 # v2 - with: - aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} - aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} - aws-region: ${{ env.AWS_REGION }} + - name: Configure AWS credentials + uses: aws-actions/configure-aws-credentials@5fd3084fc36e372ff1fff382a39b10d03659f355 # v2 + with: + aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} + aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} + aws-region: ${{ env.AWS_REGION }} + + - name: Login to Amazon ECR + id: login-ecr + uses: aws-actions/amazon-ecr-login@2fc7aceee09e9e4a7105c0d060c656fad0b4f63d # v1 + + - name: Login to GitHub Container Registry + uses: docker/login-action@465a07811f14bebb1938fbed4728c6a1ff8901fc # v2 + with: + registry: ghcr.io + username: ${{ github.repository_owner }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@885d1462b80bc1c1c7f0b00334ad271f09369c55 # v2 + + - name: Create Docker Cacha Storage Backend + run: | + docker buildx create --use --driver=docker-container + - name: See the file in the runner + run: | + ls -la + - name: Build, tag, and push image to Amazon ECR + id: build-image + uses: docker/build-push-action@0a97817b6ade9f46837855d676c4cca3a2471fc9 # v4 + env: + ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }} + IMAGE_TAG: ${{ github.sha }} + with: + context: ./backend/ + push: true + tags: ${{ env.ECR_REGISTRY }}/${{ env.ECR_REPOSITORY }}:${{ env.IMAGE_TAG }}, ${{ env.ECR_REGISTRY }}/${{ env.ECR_REPOSITORY }}:${{ github.ref_name}}, ghcr.io/QuivrHQ/quivr:${{ github.ref_name}} + cache-from: type=gha + cache-to: type=gha,mode=max - - name: Login to Amazon ECR - id: login-ecr - uses: aws-actions/amazon-ecr-login@2fc7aceee09e9e4a7105c0d060c656fad0b4f63d # v1 - - - name: Login to GitHub Container Registry - uses: docker/login-action@465a07811f14bebb1938fbed4728c6a1ff8901fc # v2 - with: - registry: ghcr.io - username: ${{ github.repository_owner }} - password: ${{ secrets.GITHUB_TOKEN }} - - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@885d1462b80bc1c1c7f0b00334ad271f09369c55 # v2 - - - name: Create Docker Cacha Storage Backend - run: | - docker buildx create --use --driver=docker-container - - name: See the file in the runner - run: | - ls -la - - name: Build, tag, and push image to Amazon ECR - id: build-image - uses: docker/build-push-action@0a97817b6ade9f46837855d676c4cca3a2471fc9 # v4 - env: - ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }} - IMAGE_TAG: ${{ github.sha }} - with: - context: ./backend/ - push: true - tags: ${{ env.ECR_REGISTRY }}/${{ env.ECR_REPOSITORY }}:${{ env.IMAGE_TAG }}, ${{ env.ECR_REGISTRY }}/${{ env.ECR_REPOSITORY }}:${{ github.ref_name}}, ghcr.io/stangirard/quivr:${{ github.ref_name}} - cache-from: type=gha - cache-to: type=gha,mode=max - deploy: needs: build_and_push runs-on: ubuntu-latest @@ -77,31 +77,30 @@ jobs: service: "prod-worker" task_definition: ".aws/task_definition_prod_worker.json" container: "quivr-chat" - steps: - - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 - - - name: Configure AWS credentials - uses: aws-actions/configure-aws-credentials@5fd3084fc36e372ff1fff382a39b10d03659f355 # v2 - with: - aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} - aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} - aws-region: ${{ env.AWS_REGION }} + - name: Checkout + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 - - name: Fill in the new image ID in the Amazon ECS task definition for ${{ matrix.name }} - id: task-def - uses: aws-actions/amazon-ecs-render-task-definition@4225e0b507142a2e432b018bc3ccb728559b437a # v1 - with: - task-definition: ${{ matrix.task_definition }} - container-name: ${{ matrix.container }} - image: ${{env.ECR_REGISTRY}}/${{ env.ECR_REPOSITORY }}:${{ github.sha }} + - name: Configure AWS credentials + uses: aws-actions/configure-aws-credentials@5fd3084fc36e372ff1fff382a39b10d03659f355 # v2 + with: + aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} + aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} + aws-region: ${{ env.AWS_REGION }} - - name: Deploy Amazon ECS task definition for ${{ matrix.name }} - uses: aws-actions/amazon-ecs-deploy-task-definition@df9643053eda01f169e64a0e60233aacca83799a # v1 - with: - task-definition: ${{ steps.task-def.outputs.task-definition }} - service: ${{ matrix.service }} - cluster: ${{ env.ECS_CLUSTER }} - wait-for-service-stability: true \ No newline at end of file + - name: Fill in the new image ID in the Amazon ECS task definition for ${{ matrix.name }} + id: task-def + uses: aws-actions/amazon-ecs-render-task-definition@4225e0b507142a2e432b018bc3ccb728559b437a # v1 + with: + task-definition: ${{ matrix.task_definition }} + container-name: ${{ matrix.container }} + image: ${{env.ECR_REGISTRY}}/${{ env.ECR_REPOSITORY }}:${{ github.sha }} + + - name: Deploy Amazon ECS task definition for ${{ matrix.name }} + uses: aws-actions/amazon-ecs-deploy-task-definition@df9643053eda01f169e64a0e60233aacca83799a # v1 + with: + task-definition: ${{ steps.task-def.outputs.task-definition }} + service: ${{ matrix.service }} + cluster: ${{ env.ECS_CLUSTER }} + wait-for-service-stability: true diff --git a/README.md b/README.md index 0cc44caef..cc13e2167 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![Discord Follow](https://dcbadge.vercel.app/api/server/HUpRgp2HG8?style=flat)](https://discord.gg/HUpRgp2HG8) -[![GitHub Repo stars](https://img.shields.io/github/stars/stangirard/quivr?style=social)](https://github.com/stangirard/quivr) +[![GitHub Repo stars](https://img.shields.io/github/stars/QuivrHQ/quivr?style=social)](https://github.com/QuivrHQ/quivr) [![Twitter Follow](https://img.shields.io/twitter/follow/StanGirard?style=social)](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. @@ -25,7 +25,7 @@ Quivr, your second brain, utilizes the power of GenerativeAI to be your personal ## Demo Highlights đŸŽ„ -https://github.com/StanGirard/quivr/assets/19614572/a6463b73-76c7-4bc0-978d-70562dca71f5 +https://github.com/QuivrHQ/quivr/assets/19614572/a6463b73-76c7-4bc0-978d-70562dca71f5 ## Getting Started 🚀 @@ -56,7 +56,7 @@ You can find the installation video [here](https://www.youtube.com/watch?v=cXBa6 - **Step 1**: Clone the repository: ```bash - git clone https://github.com/StanGirard/Quivr.git && cd Quivr + git clone https://github.com/QuivrHQ/quivr.git && cd Quivr ``` - **Step 2**: Copy the `.env.example` files @@ -118,19 +118,19 @@ You can find the installation video [here](https://www.youtube.com/watch?v=cXBa6 ## Contributors ✹ Thanks go to these wonderful people: - - + + ## 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/StanGirard/quivr/issues) -- [Open Pull Requests](https://github.com/StanGirard/quivr/pulls) -- [Good First Issues](https://github.com/StanGirard/quivr/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) -- [Frontend Issues](https://github.com/StanGirard/quivr/issues?q=is%3Aopen+is%3Aissue+label%3Afrontend) -- [Backend Issues](https://github.com/StanGirard/quivr/issues?q=is%3Aopen+is%3Aissue+label%3Abackend) +- [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 ❀ @@ -151,4 +151,4 @@ This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENS ## Stars History 📈 -[![Star History Chart](https://api.star-history.com/svg?repos=StanGirard/quivr&type=Timeline)](https://star-history.com/#StanGirard/quivr&Timeline) +[![Star History Chart](https://api.star-history.com/svg?repos=QuivrHQ/quivr&type=Timeline)](https://star-history.com/#QuivrHQ/quivr&Timeline) diff --git a/backend/models/user_usage.py b/backend/models/user_usage.py index 4f059ea7f..08678cee9 100644 --- a/backend/models/user_usage.py +++ b/backend/models/user_usage.py @@ -76,8 +76,6 @@ class UserUsage(UserIdentity): self.id, date ) - logger.info("Are you here?") - logger.info(current_requests_count) if daily_requests_count == 0: logger.info("Request count is 0, creating new record") if self.email is None: @@ -87,7 +85,6 @@ class UserUsage(UserIdentity): ) self.daily_requests_count = number return - logger.info("Request count is not 0, updating the record") self.supabase_db.increment_user_request_count( user_id=self.id, diff --git a/backend/modules/upload/tests/test_files/test.csv b/backend/modules/upload/tests/test_files/test.csv index 8d1011d2e..9c5b30b13 100644 --- a/backend/modules/upload/tests/test_files/test.csv +++ b/backend/modules/upload/tests/test_files/test.csv @@ -1,17 +1,17 @@ -StanGirard/quivr,Sat May 13 2023 02:20:09 GMT+0200 (heure d’étĂ© d’Europe centrale),0 -StanGirard/quivr,Tue May 16 2023 18:03:49 GMT+0200 (heure d’étĂ© d’Europe centrale),660 -StanGirard/quivr,Thu May 18 2023 03:04:23 GMT+0200 (heure d’étĂ© d’Europe centrale),1380 -StanGirard/quivr,Thu May 18 2023 23:04:11 GMT+0200 (heure d’étĂ© d’Europe centrale),2070 -StanGirard/quivr,Sat May 20 2023 04:44:40 GMT+0200 (heure d’étĂ© d’Europe centrale),2790 -StanGirard/quivr,Sun May 21 2023 03:19:46 GMT+0200 (heure d’étĂ© d’Europe centrale),3510 -StanGirard/quivr,Mon May 22 2023 08:03:18 GMT+0200 (heure d’étĂ© d’Europe centrale),4230 -StanGirard/quivr,Tue May 23 2023 16:57:58 GMT+0200 (heure d’étĂ© d’Europe centrale),4950 -StanGirard/quivr,Sat May 27 2023 02:18:31 GMT+0200 (heure d’étĂ© d’Europe centrale),5640 -StanGirard/quivr,Thu Jun 01 2023 18:45:27 GMT+0200 (heure d’étĂ© d’Europe centrale),6360 -StanGirard/quivr,Thu Jun 08 2023 16:33:57 GMT+0200 (heure d’étĂ© d’Europe centrale),7080 -StanGirard/quivr,Mon Jun 19 2023 12:58:34 GMT+0200 (heure d’étĂ© d’Europe centrale),7800 -StanGirard/quivr,Tue Jun 27 2023 14:45:52 GMT+0200 (heure d’étĂ© d’Europe centrale),8520 -StanGirard/quivr,Fri Jun 30 2023 11:43:51 GMT+0200 (heure d’étĂ© d’Europe centrale),9210 -StanGirard/quivr,Fri Jul 07 2023 23:08:23 GMT+0200 (heure d’étĂ© d’Europe centrale),9930 -StanGirard/quivr,Mon Jul 10 2023 08:13:07 GMT+0200 (heure d’étĂ© d’Europe centrale),10650 -StanGirard/quivr,Wed Jul 12 2023 09:40:29 GMT+0200 (heure d’étĂ© d’Europe centrale),13837 +QuivrHQ/quivr,Sat May 13 2023 02:20:09 GMT+0200 (heure d’étĂ© d’Europe centrale),0 +QuivrHQ/quivr,Tue May 16 2023 18:03:49 GMT+0200 (heure d’étĂ© d’Europe centrale),660 +QuivrHQ/quivr,Thu May 18 2023 03:04:23 GMT+0200 (heure d’étĂ© d’Europe centrale),1380 +QuivrHQ/quivr,Thu May 18 2023 23:04:11 GMT+0200 (heure d’étĂ© d’Europe centrale),2070 +QuivrHQ/quivr,Sat May 20 2023 04:44:40 GMT+0200 (heure d’étĂ© d’Europe centrale),2790 +QuivrHQ/quivr,Sun May 21 2023 03:19:46 GMT+0200 (heure d’étĂ© d’Europe centrale),3510 +QuivrHQ/quivr,Mon May 22 2023 08:03:18 GMT+0200 (heure d’étĂ© d’Europe centrale),4230 +QuivrHQ/quivr,Tue May 23 2023 16:57:58 GMT+0200 (heure d’étĂ© d’Europe centrale),4950 +QuivrHQ/quivr,Sat May 27 2023 02:18:31 GMT+0200 (heure d’étĂ© d’Europe centrale),5640 +QuivrHQ/quivr,Thu Jun 01 2023 18:45:27 GMT+0200 (heure d’étĂ© d’Europe centrale),6360 +QuivrHQ/quivr,Thu Jun 08 2023 16:33:57 GMT+0200 (heure d’étĂ© d’Europe centrale),7080 +QuivrHQ/quivr,Mon Jun 19 2023 12:58:34 GMT+0200 (heure d’étĂ© d’Europe centrale),7800 +QuivrHQ/quivr,Tue Jun 27 2023 14:45:52 GMT+0200 (heure d’étĂ© d’Europe centrale),8520 +QuivrHQ/quivr,Fri Jun 30 2023 11:43:51 GMT+0200 (heure d’étĂ© d’Europe centrale),9210 +QuivrHQ/quivr,Fri Jul 07 2023 23:08:23 GMT+0200 (heure d’étĂ© d’Europe centrale),9930 +QuivrHQ/quivr,Mon Jul 10 2023 08:13:07 GMT+0200 (heure d’étĂ© d’Europe centrale),10650 +QuivrHQ/quivr,Wed Jul 12 2023 09:40:29 GMT+0200 (heure d’étĂ© d’Europe centrale),13837 diff --git a/docker-compose.yml b/docker-compose.yml index fa8b895b3..277410835 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -22,7 +22,7 @@ services: - 3000:3000 backend-core: - image: stangirard/quivr-backend-prebuilt:latest + image: QuivrHQ/quivr-backend-prebuilt:latest pull_policy: if_not_present env_file: - .env @@ -57,7 +57,7 @@ services: worker: pull_policy: if_not_present - image: stangirard/quivr-backend-prebuilt:latest + image: QuivrHQ/quivr-backend-prebuilt:latest env_file: - .env build: @@ -70,7 +70,7 @@ services: - redis beat: - image: stangirard/quivr-backend-prebuilt:latest + image: QuivrHQ/quivr-backend-prebuilt:latest pull_policy: if_not_present env_file: - .env @@ -84,7 +84,7 @@ services: - redis flower: - image: stangirard/quivr-backend-prebuilt:latest + image: QuivrHQ/quivr-backend-prebuilt:latest pull_policy: if_not_present env_file: - .env diff --git a/docs/_snippets/commercial.mdx b/docs/_snippets/commercial.mdx index 187724ce6..ca4c9a205 100644 --- a/docs/_snippets/commercial.mdx +++ b/docs/_snippets/commercial.mdx @@ -1,2 +1,2 @@ Quivr is an open-source project supported by the community. If you'd like to contribute, please feel free to do so. We're always looking for help with documentation, bug reports and feature requests. -You can find the source code on [Github](https://github.com/stangirard/quivr), our [documentation](https://docs.quivr.app) and our Website [quivr.app](https://quivr.app). If you have any questions, please feel free to reach out to us by [mail](https://quivr.app/contact) \ No newline at end of file +You can find the source code on [Github](https://github.com/QuivrHQ/quivr), our [documentation](https://docs.quivr.app) and our Website [quivr.app](https://quivr.app). If you have any questions, please feel free to reach out to us by [mail](https://quivr.app/contact) diff --git a/docs/developers/contribution/guidelines.mdx b/docs/developers/contribution/guidelines.mdx index 71514326a..31aa94d85 100644 --- a/docs/developers/contribution/guidelines.mdx +++ b/docs/developers/contribution/guidelines.mdx @@ -15,7 +15,7 @@ We have a vibrant community over at [Discord](https://discord.gg/HUpRgp2HG8) whe Before starting, please check our project [Roadmap](https://github.com/users/StanGirard/projects/5) to see if the issue or feature you're considering is already in the works. -You can report bugs or suggest features in the [Issues](https://github.com/StanGirard/quivr/issues). Please use the provided templates and labels for bug reports and feature requests. +You can report bugs or suggest features in the [Issues](https://github.com/QuivrHQ/quivr/issues). Please use the provided templates and labels for bug reports and feature requests. ## How to Contribute @@ -31,7 +31,7 @@ Enhancements are also tracked as GitHub issues and use the feature request templ ### Code Contributions -[![inlang status badge](https://badge.inlang.com/?url=github.com/StanGirard/quivr)](https://fink.inlang.com/https://badge.inlang.com/?url=github.com/StanGirard/quivr?ref=badge) +[![inlang status badge](https://badge.inlang.com/?url=github.com/QuivrHQ/quivr)](https://fink.inlang.com/https://badge.inlang.com/?url=github.com/QuivrHQ/quivr?ref=badge) 1. Fork the repository. 2. Make your changes in a new git branch. @@ -42,14 +42,14 @@ Enhancements are also tracked as GitHub issues and use the feature request templ ### Translations -Languages: -[Spanisch](https://inlang.com/editor/github.com/StanGirard/quivr?lang=en&lang=es) -[French](https://inlang.com/editor/github.com/StanGirard/quivr?lang=en&lang=fr) -[Portuguese](https://inlang.com/editor/github.com/StanGirard/quivr?lang=en&lang=pt-br) -[Russian](https://inlang.com/editor/github.com/StanGirard/quivr?lang=en&lang=ru) -[Chinese](https://inlang.com/editor/github.com/StanGirard/quivr?lang=en&lang=fr) +Languages: +[Spanisch](https://inlang.com/editor/github.com/QuivrHQ/quivr?lang=en&lang=es) +[French](https://inlang.com/editor/github.com/QuivrHQ/quivr?lang=en&lang=fr) +[Portuguese](https://inlang.com/editor/github.com/QuivrHQ/quivr?lang=en&lang=pt-br) +[Russian](https://inlang.com/editor/github.com/QuivrHQ/quivr?lang=en&lang=ru) +[Chinese](https://inlang.com/editor/github.com/QuivrHQ/quivr?lang=en&lang=fr) -- Use the Fink editor as a translator https://inlang.com/editor/github.com/StanGirard/quivr +- Use the Fink editor as a translator https://inlang.com/editor/github.com/QuivrHQ/quivr - Use ide extension as a developer https://inlang.com/m/r7kp499g/app-inlang-ideExtension ## Submission Guidelines diff --git a/docs/developers/contribution/install.mdx b/docs/developers/contribution/install.mdx index ec4c1b0d8..23c01aaa3 100644 --- a/docs/developers/contribution/install.mdx +++ b/docs/developers/contribution/install.mdx @@ -2,6 +2,7 @@ sidebar_position: 2 title: Install --- + ## Getting Started 🚀 Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes. @@ -22,7 +23,7 @@ You can find the installation video [here](https://www.youtube.com/watch?v=cXBa6 - **Step 1**: Clone the repository: ```bash - git clone https://github.com/StanGirard/Quivr.git && cd Quivr + git clone https://github.com/QuivrHQ/quivr.git && cd Quivr ``` - **Step 2**: Copy the `.env.example` files @@ -86,4 +87,4 @@ You can find the installation video [here](https://www.youtube.com/watch?v=cXBa6 Alternatively, you can run the script on the Supabase database via the web interface (SQL Editor -> `New query` -> paste the script -> `Run`) - All the scripts can be found in the `scripts/` folder \ No newline at end of file + All the scripts can be found in the `scripts/` folder diff --git a/docs/mint.json b/docs/mint.json index 25d7c3312..4a8411b70 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -90,9 +90,7 @@ "developers/contribution/test", { "group": "RAG", - "pages": [ - "developers/contribution/chains/qa" - ] + "pages": ["developers/contribution/chains/qa"] }, { "group": "LLM", @@ -106,9 +104,7 @@ }, { "group": "Self Hosting", - "pages": [ - "developers/selfHosting/authentication" - ] + "pages": ["developers/selfHosting/authentication"] }, { "group": "Integrating", @@ -171,9 +167,7 @@ }, { "group": "Crawl", - "pages": [ - "api-reference/crawl/crawl-endpoint" - ] + "pages": ["api-reference/crawl/crawl-endpoint"] }, { "group": "Onboarding", @@ -185,9 +179,7 @@ "api-reference/root", { "group": "Upload", - "pages": [ - "api-reference/upload/upload-file" - ] + "pages": ["api-reference/upload/upload-file"] }, { "group": "User", @@ -233,9 +225,7 @@ }, { "group": "Notification", - "pages": [ - "api-reference/notification/get-notifications" - ] + "pages": ["api-reference/notification/get-notifications"] }, { "group": "Knowledge", @@ -251,7 +241,7 @@ ], "footerSocials": { "twitter": "https://twitter.com/quivr_brain", - "github": "https://github.com/stangirard/quivr", + "github": "https://github.com/QuivrHQ/quivr", "linkedin": "https://www.linkedin.com/company/getquivr", "discord": "https://discord.gg/HUpRgp2HG8" }, @@ -273,4 +263,4 @@ "apiHost": "https://us.posthog.com" } } -} \ No newline at end of file +} diff --git a/frontend/app/(home)/components/HomeHeader/hooks/useHomeHeader.tsx b/frontend/app/(home)/components/HomeHeader/hooks/useHomeHeader.tsx index 6924d2f0b..83e24751f 100644 --- a/frontend/app/(home)/components/HomeHeader/hooks/useHomeHeader.tsx +++ b/frontend/app/(home)/components/HomeHeader/hooks/useHomeHeader.tsx @@ -20,13 +20,18 @@ export const useHomeHeader = ({ color }: UseHomeHeaderProps) => { const navItems: NavbarItem[] = [ { - href: "https://github.com/StanGirard/quivr", + href: "https://github.com/QuivrHQ/quivr", label: t("star_us"), leftIcon: , rightIcon: null, }, { href: "/pricing", label: t("pricing"), rightIcon: null }, - { href: "https://docs.quivr.app", label: t("docs"), rightIcon: null, newTab: true }, + { + href: "https://docs.quivr.app", + label: t("docs"), + rightIcon: null, + newTab: true, + }, { href: "/blog", label: t("blog"), rightIcon: null, newTab: true }, { href: "/login", label: t("sign_in") }, ]; diff --git a/frontend/lib/config/CONSTANTS.ts b/frontend/lib/config/CONSTANTS.ts index 78db812b3..c2ab00772 100644 --- a/frontend/lib/config/CONSTANTS.ts +++ b/frontend/lib/config/CONSTANTS.ts @@ -1,4 +1,4 @@ -export const GITHUB_URL = "https://github.com/stangirard/quivr"; +export const GITHUB_URL = "https://github.com/QuivrHQ/quivr"; export const TWITTER_URL = "https://twitter.com/quivr_brain"; export const DISCORD_URL = "https://discord.gg/HUpRgp2HG8"; export const LINKEDIN_URL = "https://www.linkedin.com/company/getquivr";