Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ helpful contributions that mean less work for you.

## Your First Contribution

Unsure where to begin contributing? You can start by looking through some of our issues [listed here](https://github.com/RedisVentures/redis-vector-search/issues).
Unsure where to begin contributing? You can start by looking through some of our issues [listed here](https://github.com/redis-developer/redis-product-search).

## Getting Started

Expand Down
2 changes: 0 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,4 @@ COPY ./backend/ .
# add static react files to fastapi image
COPY --from=ReactImage /app/frontend/build /app/backend/productsearch/templates/build

LABEL org.opencontainers.image.source https://github.com/RedisVentures/redis-product-search

CMD ["poetry", "run", "start-app"]
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.PHONY: build

build:
docker compose -f docker-local-redis.yml up
28 changes: 6 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<br />
<br />
<div display="inline-block">
<a href="https://ecommerce.redisventures.com"><b>Hosted Demo</b></a>&nbsp;&nbsp;&nbsp;
<a href="https://ecommerce.redisvl.com/"><b>Hosted Demo</b></a>&nbsp;&nbsp;&nbsp;
<a href="https://github.com/redis-developer/redis-product-search"><b>Code</b></a>&nbsp;&nbsp;&nbsp;
<a href="https://redis.io/docs/stack/search/reference/vectors/"><b>Redis VSS Documentation</b></a>&nbsp;&nbsp;&nbsp;
</div>
Expand Down Expand Up @@ -97,37 +97,21 @@ A formatted version is available for use with this demo at:
## Running the App with docker-compose
Before running the app, install [Docker Desktop](https://www.docker.com/products/docker-desktop/).

#### Using Redis Cloud

1. [Get your Redis Cloud Database](https://app.redislabs.com/) (if needed).

2. `cp template.env .env` and update with cloud values
1. Copy .env file

```bash
REDIS_HOST=your-redis-host
REDIS_PORT=your-redis-port
REDIS_PASSOWRD=your-redis-password
cp .env.template .env
```

3. Run the App:
```bash
$ docker compose -f docker-cloud-redis.yml up
```

> The benefit of this approach is that the db will persist beyond application runs. So you can make updates and re run the app without having to provision the dataset or create another search index.

#### Running the app locally using docker

1. `cp template.env .env`
2. Run docker containers with `make`

2. Run compose command
```bash
$ docker compose -f docker-local-redis.yml up
make build
```

Note: you can add `--build` and `--force-recreate` if caching old images.

## Running without docker-compose
## Running local without docker-compose

### Run frontend

Expand Down
1 change: 0 additions & 1 deletion build.sh
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can keep this idea though and add it to a script through poetry so it's easy to build the docker image if you need it separately

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this would be a case for a make file like we do in redisvl now since poetry is contained under backend in this project since it's full stack. Added for this purpose.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good!

This file was deleted.

11 changes: 0 additions & 11 deletions docker-cloud-redis.yml

This file was deleted.