frishi/threetwo-core-service
1
0
Fork 0
Code Issues 2 Pull Requests 2 Actions Packages Projects Releases Wiki Activity

✏️ Added local dev instructions to README

Browse Source
This commit is contained in:
Rishi Ghan
2021-09-01 17:27:40 -07:00
parent f4f217400c
commit 4c598e37a1
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -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.