mirror of
https://github.com/StanGirard/quivr.git
synced 2024-11-24 05:55:13 +03:00
feat(docs): added env file
This commit is contained in:
Stan Girard
parent
b5cf350485
commit
769c0a5ad0
@ -1,5 +1,5 @@
|
||||
{
|
||||
"label": "📲 Connect Quivr to ...",
|
||||
"label": "Chat to Quivr with ...",
|
||||
"position": 3,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
{
|
||||
"label": "⌨️ Contribute to Quivr",
|
||||
"label": "Explanation",
|
||||
"position": 1,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: 🏛️ Architecture
|
||||
title: Architecture
|
||||
---
|
||||
|
||||
Quivr is using FastAPI to provide a RESTful API for the backend. The API is currently in beta and is subject to change. The API is available at [https://api.quivr.app](https://api.quivr.app).
|
||||
|
||||
@ -1,9 +1,8 @@
|
||||
{
|
||||
"label": "⛓️ Chains",
|
||||
"label": "Chains",
|
||||
"position": 5,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "What are chains?"
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
74
docs/docs/Developers/contribution/env.md
Normal file
74
docs/docs/Developers/contribution/env.md
Normal file
@ -0,0 +1,74 @@
|
||||
---
|
||||
title: Environment File
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
You have two environment files in the root of the project:
|
||||
|
||||
One in `backend/.env` and the other in `frontend/.env`.
|
||||
|
||||
### Backend Environment File
|
||||
|
||||
The backend environment file is used to configure the backend server. It contains the following variables:
|
||||
|
||||
- `SUPABASE_URL`: The connection string to the project's Supabase application, which is a suite of open source tools that provide functionality similar to Firebase.
|
||||
|
||||
- `SUPABASE_SERVICE_KEY`: Used for server-side requests to authenticate with Supabase, providing administrative access to the database and other services.
|
||||
|
||||
- `OPENAI_API_KEY`: The key required to authenticate requests to OpenAI's API for accessing their services, such as language models like GPT-3 or GPT-4.
|
||||
|
||||
- `JWT_SECRET_KEY`: A secret key for signing and verifying JSON Web Tokens, used in the authentication process to secure the tokens exchanged between client and server.
|
||||
|
||||
- `CELERY_BROKER_URL`: The URL of the message broker for Celery (using Redis), which is an asynchronous task queue/job queue based on distributed message passing.
|
||||
|
||||
- `RESEND_API_KEY`: The API key for a service referred to as "RESEND," which likely deals with email sending or processing.
|
||||
|
||||
- `RESEND_EMAIL_ADDRESS`: The email address used by the "RESEND" service, possibly as the sender's address for onboarding communications.
|
||||
|
||||
- `RESEND_CONTACT_SALES_FROM`: The sender's email address for sales-related inquiries sent through the "RESEND" service.
|
||||
|
||||
- `RESEND_CONTACT_SALES_TO`: The recipient's email address for sales inquiries using the "RESEND" service.
|
||||
|
||||
- `PREMIUM_MAX_BRAIN_NUMBER`: A limit on the number of 'brains' a premium user can have
|
||||
|
||||
- `PREMIUM_MAX_BRAIN_SIZE`: The maximum allowed size for a 'brain'
|
||||
|
||||
- `PREMIUM_DAILY_CHAT_CREDIT`: The number of daily credits allocated to a premium user, possibly limiting the number of API calls or operations a user can perform each day.
|
||||
|
||||
### Frontend Environment File
|
||||
|
||||
The frontend environment file is used to configure the frontend application. It contains the following variables:
|
||||
|
||||
- `NEXT_PUBLIC_ENV`: Specifies the environment in which the Next.js application is running (e.g., local, development, production).
|
||||
|
||||
- `NEXT_PUBLIC_BACKEND_URL`: The URL where the backend of the application is running, used to make server-side requests.
|
||||
|
||||
- `NEXT_PUBLIC_FRONTEND_URL`: The URL where the frontend of the application is accessible. The asterisk (*) may indicate that any port can be used when running locally.
|
||||
|
||||
- `NEXT_PUBLIC_SUPABASE_URL`: The connection string to the project's Supabase application for the frontend to interact with Supabase services.
|
||||
|
||||
- `NEXT_PUBLIC_SUPABASE_ANON_KEY`: The public 'anonymous' key for Supabase that is used in the frontend for services that don't require full user authentication.
|
||||
|
||||
- `NEXT_PUBLIC_GROWTHBOOK_CLIENT_KEY`: The client key for GrowthBook, which is a feature flagging and experimentation platform. The variable might be set to a default or placeholder value.
|
||||
|
||||
- `NEXT_PUBLIC_GROWTHBOOK_URL`: The URL for the GrowthBook service. This is also set to a default or placeholder value.
|
||||
|
||||
- `NEXT_PUBLIC_JUNE_API_KEY`: The API key for accessing June services, which is likely analytics or marketing related, again set to a default or placeholder value.
|
||||
|
||||
- `NEXT_PUBLIC_GA_ID`: The tracking ID for Google Analytics, which is used to monitor and track user interactions on the website.
|
||||
|
||||
- `NEXT_PUBLIC_E2E_URL`: The URL for end-to-end (E2E) testing, usually pointing to a testing environment.
|
||||
|
||||
- `NEXT_PUBLIC_E2E_EMAIL`: An email address used for end-to-end testing purposes.
|
||||
|
||||
- `NEXT_PUBLIC_E2E_PASSWORD`: A password used in conjunction with the E2E_EMAIL for testing authentication flows.
|
||||
|
||||
- `NEXT_PUBLIC_CMS_URL`: The URL to access the Content Management System (CMS) for the application.
|
||||
|
||||
- `NEXT_PUBLIC_STRIPE_PRICING_TABLE_ID`: An identifier for a pricing table in Stripe, which is a payment processing platform.
|
||||
|
||||
- `NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY`: The publishable key for Stripe, used to initiate transactions on the frontend.
|
||||
|
||||
- `NEXT_PUBLIC_STRIPE_MANAGE_PLAN_URL`: The URL for managing Stripe subscription plans.
|
||||
|
||||
- `NEXT_PUBLIC_AUTH_MODES`: The authentication modes supported by the application, such as magic link, password-based authentication, and Google Single Sign-On (SSO).
|
||||
@ -1,5 +1,5 @@
|
||||
{
|
||||
"label": "💻 Frontend",
|
||||
"label": "Frontend",
|
||||
"position": 4,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: 🆘 Guidelines
|
||||
title: Guidelines
|
||||
---
|
||||
|
||||
# Contributing to Quivr
|
||||
@ -12,6 +12,7 @@ Thanks for your interest in contributing to Quivr! Here you'll find guidelines f
|
||||
## Table of Contents
|
||||
|
||||
- [Contributing to Quivr](#contributing-to-quivr)
|
||||
- [Repo: Quivr Github](#repo-quivr-github)
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [Community](#community)
|
||||
- [Roadmap and Issues](#roadmap-and-issues)
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: 🧑💻 Install Quivr
|
||||
title: Install Quivr
|
||||
---
|
||||
|
||||
Sure, here's an improved version of your markdown document:
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
title: 🧪 Testing Strategies
|
||||
title: Testing Strategies
|
||||
---
|
||||
|
||||
## Backend
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: 📍 Run Quivr fully locally
|
||||
title: Run Quivr fully locally
|
||||
---
|
||||
|
||||
# Using Quivr fully locally
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
{
|
||||
"label": "🔗 Use Quivr Backend",
|
||||
"label": "Use Quivr Backend",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
{
|
||||
"label": "🧠 Brain",
|
||||
"label": "Brain",
|
||||
"position": 3,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: 🆕 Create a brain
|
||||
title: Create a brain
|
||||
---
|
||||
|
||||
To create a brain, you need to make a POST request to the `/brains/` endpoint. This endpoint requires authentication, and you need to provide the following parameters in the request body:
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: 🧠 Get a Brain
|
||||
title: Get a Brain
|
||||
---
|
||||
|
||||
To get a brain, you need to make a GET request to the following endpoints.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: 🫵 Set a Default Brain
|
||||
title: Set a Default Brain
|
||||
---
|
||||
|
||||
To set a brain as the default for the current user, you need to make a POST request to the following endpoint:
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: ✍️ Update a Brain
|
||||
title: Update a Brain
|
||||
---
|
||||
|
||||
To update a brain, you need to make a PUT request to the following endpoint:
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: 🤖 Chat system
|
||||
title: Chat system
|
||||
---
|
||||
|
||||
**URL**: https://api.quivr.app/chat
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
title: 😩 Error Handling
|
||||
title: Error Handling
|
||||
---
|
||||
|
||||
**URL**: https://api.quivr.app/chat
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: 🔐 Get your API key
|
||||
title: Get your API key
|
||||
---
|
||||
|
||||
To use the Quivr API, you need to get an API key. You can get one by following these steps:
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: ❓ How to use the API
|
||||
title: How to use the API
|
||||
---
|
||||
|
||||
**URL**: https://api.quivr.app
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: 🕺 Getting started
|
||||
title: Getting started
|
||||
---
|
||||
|
||||
## How to get started ? 👀
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: 🧠 Concept of Brain
|
||||
title: Concept of Brain
|
||||
---
|
||||
|
||||
:::info
|
||||
|
||||
@ -1,90 +0,0 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
title: 👀 Privacy Policy
|
||||
---
|
||||
|
||||
## Privacy Policy for Quivr
|
||||
At Quivr, accessible from quivr.app, one of our main priorities is the privacy of our visitors. This Privacy Policy document contains types of information that is collected and recorded by Quivr and how we use it.
|
||||
|
||||
If you have additional questions or require more information about our Privacy Policy, do not hesitate to contact us.
|
||||
|
||||
This Privacy Policy applies only to our online activities and is valid for visitors to our website with regards to the information that they shared and/or collect in Quivr. This policy is not applicable to any information collected offline or via channels other than this website.
|
||||
|
||||
Consent
|
||||
By using our website, you hereby consent to our Privacy Policy and agree to its terms.
|
||||
|
||||
Information we collect
|
||||
The personal information that you are asked to provide, and the reasons why you are asked to provide it, will be made clear to you at the point we ask you to provide your personal information.
|
||||
|
||||
If you contact us directly, we may receive additional information about you such as your name, email address, phone number, the contents of the message and/or attachments you may send us, and any other information you may choose to provide.
|
||||
|
||||
When you register for an Account, we may ask for your contact information, including items such as name, company name, address, email address, and telephone number.
|
||||
|
||||
How we use your information
|
||||
We use the information we collect in various ways, including to:
|
||||
|
||||
Provide, operate, and maintain our website
|
||||
Improve, personalize, and expand our website
|
||||
Understand and analyze how you use our website
|
||||
Develop new products, services, features, and functionality
|
||||
Communicate with you, either directly or through one of our partners, including for customer service, to provide you with updates and other information relating to the website, and for marketing and promotional purposes
|
||||
Send you emails
|
||||
Find and prevent fraud
|
||||
Log Files
|
||||
Quivr follows a standard procedure of using log files. These files log visitors when they visit websites. All hosting companies do this and a part of hosting services' analytics. The information collected by log files include internet protocol (IP) addresses, browser type, Internet Service Provider (ISP), date and time stamp, referring/exit pages, and possibly the number of clicks. These are not linked to any information that is personally identifiable. The purpose of the information is for analyzing trends, administering the site, tracking users' movement on the website, and gathering demographic information.
|
||||
|
||||
Cookies and Web Beacons
|
||||
Like any other website, Quivr uses "cookies". These cookies are used to store information including visitors' preferences, and the pages on the website that the visitor accessed or visited. The information is used to optimize the users' experience by customizing our web page content based on visitors' browser type and/or other information.
|
||||
|
||||
Advertising Partners Privacy Policies
|
||||
You may consult this list to find the Privacy Policy for each of the advertising partners of Quivr.
|
||||
|
||||
Third-party ad servers or ad networks uses technologies like cookies, JavaScript, or Web Beacons that are used in their respective advertisements and links that appear on Quivr, which are sent directly to users' browser. They automatically receive your IP address when this occurs. These technologies are used to measure the effectiveness of their advertising campaigns and/or to personalize the advertising content that you see on websites that you visit.
|
||||
|
||||
Note that Quivr has no access to or control over these cookies that are used by third-party advertisers.
|
||||
|
||||
Third Party Privacy Policies
|
||||
Quivr's Privacy Policy does not apply to other advertisers or websites. Thus, we are advising you to consult the respective Privacy Policies of these third-party ad servers for more detailed information. It may include their practices and instructions about how to opt-out of certain options.
|
||||
|
||||
You can choose to disable cookies through your individual browser options. To know more detailed information about cookie management with specific web browsers, it can be found at the browsers' respective websites.
|
||||
|
||||
CCPA Privacy Rights (Do Not Sell My Personal Information)
|
||||
Under the CCPA, among other rights, California consumers have the right to:
|
||||
|
||||
Request that a business that collects a consumer's personal data disclose the categories and specific pieces of personal data that a business has collected about consumers.
|
||||
|
||||
Request that a business delete any personal data about the consumer that a business has collected.
|
||||
|
||||
Request that a business that sells a consumer's personal data, not sell the consumer's personal data.
|
||||
|
||||
If you make a request, we have one month to respond to you. If you would like to exercise any of these rights, please contact us.
|
||||
|
||||
GDPR Data Protection Rights
|
||||
We would like to make sure you are fully aware of all of your data protection rights. Every user is entitled to the following:
|
||||
|
||||
The right to access – You have the right to request copies of your personal data. We may charge you a small fee for this service.
|
||||
|
||||
The right to rectification – You have the right to request that we correct any information you believe is inaccurate. You also have the right to request that we complete the information you believe is incomplete.
|
||||
|
||||
The right to erasure – You have the right to request that we erase your personal data, under certain conditions.
|
||||
|
||||
The right to restrict processing – You have the right to request that we restrict the processing of your personal data, under certain conditions.
|
||||
|
||||
The right to object to processing – You have the right to object to our processing of your personal data, under certain conditions.
|
||||
|
||||
The right to data portability – You have the right to request that we transfer the data that we have collected to another organization, or directly to you, under certain conditions.
|
||||
|
||||
If you make a request, we have one month to respond to you. If you would like to exercise any of these rights, please contact us.
|
||||
|
||||
Children's Information
|
||||
Another part of our priority is adding protection for children while using the internet. We encourage parents and guardians to observe, participate in, and/or monitor and guide their online activity.
|
||||
|
||||
Quivr does not knowingly collect any Personal Identifiable Information from children under the age of 13. If you think that your child provided this kind of information on our website, we strongly encourage you to contact us immediately and we will do our best efforts to promptly remove such information from our records.
|
||||
|
||||
Changes to This Privacy Policy
|
||||
We may update our Privacy Policy from time to time. Thus, we advise you to review this page periodically for any changes. We will notify you of any changes by posting the new Privacy Policy on this page. These changes are effective immediately, after they are posted on this page.
|
||||
|
||||
Our Privacy Policy was created with the help of the Privacy Policy Generator.
|
||||
|
||||
Contact Us
|
||||
If you have any questions or suggestions about our Privacy Policy, do not hesitate to contact us.
|
||||
Loading…
Reference in New Issue
Block a user