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

📕 Updated local dev instructions in README

Browse Source
This commit is contained in:
Rishi Ghan
2023-09-01 09:22:02 -05:00
parent 9e47ae0436
commit 1d7561279b
1 changed files with 17 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -3,21 +3,29 @@
This [moleculer-based](https://github.com/moleculerjs/moleculer-web) microservice houses endpoints for the following functions: This [moleculer-based](https://github.com/moleculerjs/moleculer-web) microservice houses endpoints for the following functions:
1. Local import of a comic library into mongo (currently supports `cbr` and `cbz` files) 1. Local import of a comic library into mongo (currently supports `cbr` and `cbz` files)
2. Metadata extraction from file, `comicinfo.xml` 2. Metadata extraction from file, `comicinfo.xml`
3. Mongo comic object orchestration 3. Mongo comic object orchestration
4. CRUD operations on `Comic` model 4. CRUD operations on `Comic` model
5. Helper utils to help with image metadata extraction, file operations and more. 5. Helper utils to help with image metadata extraction, file operations and more.
## Local Development ## Local Development
1. ~~You need `calibre` in your local path. 1. You need the following dependencies installed: `mongo`, `elasticsearch` and `redis`
On `macOS` you can `brew install calibre` and make sure that `ebook-meta` is present on the path~~ Calibre is no longer required as a dependency. Ignore this step. 2. Clone this repo
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. Run `npm i`
3. Clone this repo 4. Assuming you installed the dependencies correctly, run:
4. Run `npm i` ```
5. Assuming you installed mongo correctly, run `MONGO_URI=mongodb://localhost:27017/threetwo npm run dev` to start the service COMICS_DIRECTORY=<PATH_TO_COMICS_DIRECTORY> \
6. You should see the service spin up and a list of all the endpoints in the terminal USERDATA_DIRECTORY=<PATH_TO_USERDATA_DIRECTORY> \
7. The service can be accessed through `http://localhost:3000/api/import/*` REDIS_URI=redis://<REDIS_HOST:REDIS_PORT> \
ELASTICSEARCH_URI=<ELASTICSEARCH_HOST:ELASTICSEARCH_PORT> \
MONGO_URI=mongodb://<MONGO_HOST:MONGO_PORT>/threetwo \
npm run dev
```
to start the service
5. You should see the service spin up and a list of all the endpoints in the terminal
6. The service can be accessed through `http://localhost:3000/api/<serviceName>/*`
## Docker Instructions ## Docker Instructions
1. Build the image using `docker build . -t frishi/threetwo-import-service`. Give it a hot minute. 1. Build the image using `docker build . -t frishi/threetwo-import-service`. Give it a hot minute.