diff --git a/template.env b/.env.template similarity index 100% rename from template.env rename to .env.template diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 919d281..58dd032 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/Dockerfile b/Dockerfile index c49dd27..17d3782 100644 --- a/Dockerfile +++ b/Dockerfile @@ -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"] \ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..18a0cd6 --- /dev/null +++ b/Makefile @@ -0,0 +1,4 @@ +.PHONY: build + +build: + docker compose -f docker-local-redis.yml up \ No newline at end of file diff --git a/README.md b/README.md index 182850e..4455d64 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@

- Hosted Demo    + Hosted Demo    Code    Redis VSS Documentation   
@@ -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 diff --git a/build.sh b/build.sh deleted file mode 100755 index 13bb81b..0000000 --- a/build.sh +++ /dev/null @@ -1 +0,0 @@ -docker build -t redisventures/redis-product-search:latest . \ No newline at end of file diff --git a/docker-cloud-redis.yml b/docker-cloud-redis.yml deleted file mode 100644 index 920f52e..0000000 --- a/docker-cloud-redis.yml +++ /dev/null @@ -1,11 +0,0 @@ -version: '3.11' - -services: - backend: - image: ghcr.io/redisventures/redis-product-search:latest - env_file: - - .env - expose: - - "8888" - ports: - - "8888:8888"