Skip to content

Commit 58b5715

Browse files
committed
docs: improve Readme
1 parent 0d60e8d commit 58b5715

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,18 @@
163163
Runs the Topcoder TaaS API using nodemon, so it would be restarted after any of the files is updated.
164164
The Topcoder TaaS API will be served on `http://localhost:3000`.
165165

166+
### Working on `taas-es-processor` locally
167+
168+
When you run `taas-apis` locally as per "[Steps to run locally](#steps-to-run-locally)" the `taas-es-processor` would be run for you automatically together with other services inside the docker container when you run `npm run services:up`.
169+
170+
To be able to change and test `taas-es-processor` locally you can follow the next steps:
171+
172+
1. Stop `taas-es-processor` inside docker by running `docker-compose -f local/docker-compose.yml stop taas-es-processor`
173+
2. Run `taas-es-processor` separately from the [source code](https://github.com/topcoder-platform/taas-es-processor). As `npm run services:up` already run all the dependencies for both `taas-apis` and for `taas-es-processor`. The only thing you need to do for running `taas-es-processor` locally is:
174+
- `nvm use` - to use correct Node version
175+
- `npm run install`
176+
- `npm run start`
177+
166178
## NPM Commands
167179

168180
| Command                    | Description |

0 commit comments

Comments
 (0)