From 4c598e37a1be2e11d3072053c45fdf8780d99dd3 Mon Sep 17 00:00:00 2001 From: Rishi Ghan Date: Wed, 1 Sep 2021 17:27:40 -0700 Subject: [PATCH] =?UTF-8?q?=E2=9C=8F=EF=B8=8F=20Added=20local=20dev=20inst?= =?UTF-8?q?ructions=20to=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 92805ea..ae5f94d 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,16 @@ This microservice houses endpoints for the following functions: 4. CRUD operations on `Comic` model 5. Helper utils to help with image metadata extraction, file operations and more. +## Local Development + +1. You need `calibre` in your local path + On `macOS` you can `brew install calibre` and make sure that `ebook-meta` is present on the path +2. You need `mongo` for the data store. on `macOS` you can use [these instructions](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-os-x/) to install it +3. Clone this repo +4. Run `npm i` +5. Assuming you installed mongo correctly, run `MONGO_URI=mongodb://localhost:27017/threetwo npm run dev` +6. You should see the service spin up and a list of all the endpoints in the terminal +7. The service can be accessed through `http://localhost/api/import/*` ## Docker Instructions 1. Build the image using `docker build . -t frishi/threetwo-import-service`. Give it a hot minute.