From 997f03facb62485f5eed4afcbdf71c1e8b40471f Mon Sep 17 00:00:00 2001 From: simon987 Date: Sun, 28 Mar 2021 11:42:10 -0400 Subject: [PATCH] Update readme --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a306c83..8783604 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,14 @@ # imhashdb -### Requirements -1. PostgreSQL -1. Redis -1. [pg_hamming](https://github.com/simon987/pg_hamming) -1. [fastimagehash](https://github.com/simon987/fastimagehash) +### Setup (development): + +1. Install PostgreSQL 12 +1. Install [pg_hamming](https://github.com/simon987/pg_hamming) +1. Create a database called `imhashdb` (`su postgres; createdb imhashdb`) +1. Install redis-server +1. Install [fastimagehash](https://github.com/simon987/fastimagehash) +1. Start an instance of `imhashdb hasher` (See `./imhashdb --help` for CLI options) +1. Start an image crawler (e.g. `reddit_feed`), with `ARC_LIST=imhash,...` +1. Start an instance of `imhashdb web` +1. Start the development web server [imhashdb-frontend](https://github.com/simon987/imhashdb-frontend) + - Run `npm run start`