Archives/DocsGPT
2
0
Fork 0
mirror of https://github.com/arc53/DocsGPT synced 2024-11-17 21:26:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
ArpitPandey29 2023-11-01 09:57:31 +05:30 committed by GitHub
parent 715cd9daf5
commit 23b6a38e18
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -23,22 +23,19 @@ Say goodbye to time-consuming manual searches, and let <strong><a href="https://
</div>
### Production Support / Help for companies:
### Production Support / Help for Companies:
We're eager to provide personalized assistance when deploying your DocsGPT to a live environment.
- [Book Demo :wave:](https://airtable.com/appdeaL0F1qV8Bl2C/shrrJF1Ll7btCJRbP)
- [Send Email :email:](mailto:contact@arc53.com?subject=DocsGPT%20support%2Fsolutions)
### [:tada: Join the Hacktoberfest with DocsGPT and Earn a Free T-shirt! :tada:](https://github.com/arc53/DocsGPT/blob/main/HACKTOBERFEST.md)
![video-example-of-docs-gpt](https://d3dg1063dc54p9.cloudfront.net/videos/demov3.gif)
## Roadmap
You can find our roadmap [here](https://github.com/orgs/arc53/projects/2). Please don't hesitate to contribute or create issues, it helps us improve DocsGPT!
## Our Open-Source models optimized for DocsGPT:
## Our Open-Source Models Optimized for DocsGPT:
| Name | Base Model | Requirements (or similar) |
| --------------------------------------------------------------------- | ----------- | ------------------------- |
@ -52,7 +49,7 @@ If you don't have enough resources to run it, you can use bitsnbytes to quantize
![Main features of DocsGPT showcasing six main features](https://user-images.githubusercontent.com/17906039/220427472-2644cff4-7666-46a5-819f-fc4a521f63c7.png)
## Useful links
## Useful Links
- :mag: :fire: [Live preview](https://docsgpt.arc53.com/)
@ -66,7 +63,7 @@ If you don't have enough resources to run it, you can use bitsnbytes to quantize
- :house: :closed_lock_with_key: [How to host it locally (so all data will stay on-premises)](https://docs.docsgpt.co.uk/Guides/How-to-use-different-LLM)
## Project structure
## Project Structure
- Application - Flask app (main application).
@ -80,7 +77,7 @@ If you don't have enough resources to run it, you can use bitsnbytes to quantize
Note: Make sure you have [Docker](https://docs.docker.com/engine/install/) installed
On macOS or Linux, write:
On Mac OS or Linux, write:
`./setup.sh`
@ -104,9 +101,9 @@ Otherwise, refer to this Guide:
To stop, just run `Ctrl + C`.
## Development environments
## Development Environments
### Spin up mongo and redis
### Spin up Mongo and Redis
For development, only two containers are used from [docker-compose.yaml](https://github.com/arc53/DocsGPT/blob/main/docker-compose.yaml) (by deleting all services except for Redis and Mongo).
See file [docker-compose-dev.yaml](./docker-compose-dev.yaml).
@ -118,7 +115,7 @@ docker compose -f docker-compose-dev.yaml build
docker compose -f docker-compose-dev.yaml up -d
```
### Run the backend
### Run the Backend
Make sure you have Python 3.10 or 3.11 installed.
@ -130,7 +127,7 @@ Make sure you have Python 3.10 or 3.11 installed.
2. (optional) Create a Python virtual environment:
You can follow the [Python official documentation](https://docs.python.org/3/tutorial/venv.html) for virtual environments.
a) On macOS and Linux
a) On Mac OS and Linux
```commandline
python -m venv venv
@ -153,7 +150,7 @@ pip install -r requirements.txt
4. Run the app using `flask --app application/app.py run --host=0.0.0.0 --port=7091`.
5. Start worker with `celery -A application.app.celery worker -l INFO`.
### Start frontend
### Start Frontend
Make sure you have Node version 16 or higher.