If you see a step below that could be improved (or is outdated), please update the instructions. We rarely go through this process ourselves, so your fresh pair of eyes and your recent experience with it, makes you the best candidate to improve them for other users. Thank you!
Set the following environment variables in .env.
API_HYPERWATCH_URL=wss://{API_DOMAIN}/{HYPERWATCH_PATH}/logs/raw
API_HYPERWATCH_USERNAME={USERNAME}
API_HYPERWATCH_SECRET={SECRET}
Then, start with:
npm run start:api
You can use the following the URL:
- see pipeline status: http://localhost:3360/status
- browse identities: http://localhost:3360/identities
- browse identities: http://localhost:3360/addresses
- watch real time logs: http://localhost:3360/logs/main
Set the following environment variables in .env.
FRONTEND_HYPERWATCH_URL=wss://{FRONTEND_DOMAIN}/{HYPERWATCH_PATH}/logs/raw
FRONTEND_HYPERWATCH_USERNAME={USERNAME}
FRONTEND_HYPERWATCH_SECRET={SECRET}
Then, start with:
npm run start:frontend
Set the following environment variables in .env.
IMAGES_HYPERWATCH_URL=wss://{IMAGES_DOMAIN}/{HYPERWATCH_PATH}/logs/raw
IMAGES_HYPERWATCH_USERNAME={USERNAME}
IMAGES_HYPERWATCH_SECRET={SECRET}
Then, start with:
npm run start:images
Set the following environment variables in .env.
REST_HYPERWATCH_URL=wss://{REST_DOMAIN}/{HYPERWATCH_PATH}/logs/raw
REST_HYPERWATCH_USERNAME={USERNAME}
REST_HYPERWATCH_SECRET={SECRET}
Then, start with:
npm run start:rest
Clone and link Hyperwatch:
git clone [email protected]:hyperwatch/hyperwatch.git
cd hyperwatch
npm install
npm link
Then link in the current project:
npm link @hyperwatch/hyperwatch
Code style? Commit convention?
TL;DR: we use Prettier and ESLint, we do like great commit messages and clean Git history.
If you have any questions, ping us on Slack (https://slack.opencollective.org) or on Twitter (@opencollect).
