Skip to content

Contribution Guide

Jump to bottom
ChakshuGautam edited this page Jul 23, 2021 · 2 revisions

Setting up the env

  • Node version - 12 and above; NPM version - 6.14; Yarn version- 1.22;
  • Use the env.sample file to setup the .env file inside the src directory.
  • Install dev dependencies - yarn -i

Starting the dev server

  • Install nodemon if you don't already have that.
  • Start the server using nodemon start. You should see something like this to signify the services are up. Not all services need to be up for the service to run.
Server running in prod env on port 9999 with 62722 pid ✅
Telemetry is initialized.
Kafka Connection Status: ✅
Scheduler DB Status: ✅
Scheduler Status: ✅
DB Connection ✅
Model Initialization: ✅
========--=-=-=-=-=-

Attaching a debugger (Optional)

If you are using VS code, set your config for the debugger to Auto Attach: Always and it should be picked up automatically when using VS code terminal. It should show the following output

Debugger listening on ws://127.0.0.1:55844/35ea8d64-fd7e-43ce-94c2-e80a252e4f77
For help, see: https://nodejs.org/en/docs/inspector
Debugger attached.

Sharing your env with frontend (Optional)

  • Install localtunnel
  • Share your port 9999 over https using the following
lt --port 9999 --host http://x.y.g --print-requests --subdomain uci-local-server
  • You should get the following output which you can share with anyone testing the frontend.
your url is: https://uci-local-server.x.y.g/

You can get the sandbox localtunnel server by pinging on the slack here - [email protected].

Clone this wiki locally