summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJules Laplace <julescarbon@gmail.com>2019-04-27 23:08:53 +0200
committerJules Laplace <julescarbon@gmail.com>2019-04-27 23:08:53 +0200
commitf82e99ccf61366c3528bf2777f532c76a148c98b (patch)
tree3358ce3e52c513a6c968d233e324423c3a550269
parent2716217a4edb576cd5bd211b17fc8e5c88f9489a (diff)
readme
-rw-r--r--README.md31
1 files changed, 23 insertions, 8 deletions
diff --git a/README.md b/README.md
index 2cbc5f6..5c16251 100644
--- a/README.md
+++ b/README.md
@@ -31,6 +31,29 @@ DB_USER=vframe_check
DB_PASS=some_new_password
```
+The initial dataset can be hosted locally for now - make sure files are accessible inside `check/static/`. These paths will be added directly to the dataset.
+
+```
+python cli_phash.py import -i 'static/sample_set_test_01/images/*'
+```
+
+Build the Javascript frontend:
+
+```
+npm run watch
+npm run build
+```
+
+Run the server:
+
+```
+cd check
+python cli_flask.py run
+```
+
+The server will be running on http://0.0.0.0:5000/
+
+
### Endpoints
#### POST /v1/match
@@ -55,11 +78,3 @@ Form parameters:
- `url` - Image URL to fetch and test (will be stored if `add` is true)
- `q` (file) - Uploaded file to test (will not be stored)
-
-### Importing files
-
-The initial dataset can be hosted locally for now - make sure files are accessible inside `check/static/`. These paths will be added directly to the dataset.
-
-```
-python cli_phash.py import -i 'static/sample_set_test_01/images/*'
-```