-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
home page badges & installation guide (#84)
* Add github to doc navbar * Don't autoplay the quick start video * git and discord badge * Update README.md * Update README.md * Update README.md * Update README.md * installation * polish readme and update installation with python/pip version and installation * Update installation.md * Update installation.md * Update README.md * Update README.md * Update README.md * Update installation.md * Update README.md * Update README.md * Update README.md * Update installation.md * Update installation.md
- Loading branch information
1 parent
e846a28
commit ceabc3a
Showing
3 changed files
with
45 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
title: Installation | ||
description: Setup the CocoIndex environment in 0-3 min | ||
--- | ||
|
||
## 🐍 Python and Pip | ||
To follow the steps in this guide, you'll need: | ||
|
||
1. Install [Python](https://wiki.python.org/moin/BeginnersGuide/Download/). We support Python 3.11 to 3.13. | ||
2. Install [pip](https://pip.pypa.io/en/stable/installation/) - a Python package installer | ||
|
||
|
||
## 🌴 Install CocoIndex | ||
```bash | ||
pip install cocoindex | ||
``` | ||
|
||
## 📦 Install Postgres | ||
|
||
You can skip this step if you already have a Postgres database with pgvector extension installed. | ||
|
||
If you don't have a Postgres database: | ||
|
||
1. Install [Docker Compose](https://docs.docker.com/compose/install/) 🐳. | ||
2. Start a Postgres SQL database for cocoindex using our docker compose config: | ||
|
||
```bash | ||
docker compose -f <(curl -L https://raw.githubusercontent.com/cocoindex-io/cocoindex/refs/heads/main/dev/postgres.yaml) up -d | ||
``` | ||
|
||
## 🎉 All set! | ||
|
||
You can now start using CocoIndex. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters