✏️ Added notes on how to start the service

This commit is contained in:
2021-09-02 00:15:30 -07:00
parent 9361b8d4e3
commit 14a16ead50

View File

@@ -1,14 +1,15 @@
# comicvine-service
This microservice houses [comicvine](http://comicvine.gamespot.com) related endpoints that are used
to fetch metadata for various reasons on [ThreeTwo!](https://github.com/rishighan/threetwo).
This [moleculer-based](https://github.com/moleculerjs/moleculer-web) microservice houses [comicvine](http://comicvine.gamespot.com) related endpoints that are used
to fetch metadata for various reasons on [ThreeTwo!](https://github.com/rishighan/threetwo)
## Local Development
1. Clone this repo
2. Run `npm i`
3. You should see the service spin up and a list of all the endpoints in the terminal
4. The service can be accessed through `http://localhost:3080/api/comicvine/*`
4. Run the service using `npm run dev`
5. The service can be accessed through `http://localhost:3080/api/comicvine/*`
## Docker Instructions
1. Build the image using `docker build . -t frishi/threetwo-import-service`. Give it a hot minute.