validator-service is a Node application for candid, the engineering steps can be found on this docs Candid-Engineering-Docs
More information on this can be found on the engineering docs, present at Candid-Engineering-Docs and the technologies involved includes: Nodejs
, npm
, PG Database
, Prisma CLI
and Expressjs
NB: The Application is fully running on a CI/CD Pipeline, which tests, builds and deploys the code, anything it's merge and added to the main branch
Currently, we can run the app using Docker or through by just using common node commands, in the first step, we'd be exploring how to run the validator-service using docker, then in the second step, i'd show how to use common node commands to run the dev server
NB: Make sure you have docker installed on your computer, before executing the commands please
docker build -t candid .
To run with docker, firstly, have all the env variables in .env
and .env.dev
file in our project root. but considering the fact that the only env variable is the port, this docs would constantly change to fit in new adjustments
Then, build the project -
docker run -p 3000:3000 candid
As mentioned earlier, you will need docker installed in your computer. For help with installation, ask in slack.
For this to work, make sure you've nodejs => 18.x installed on your system, before running the following comands
npm install
After Successful installation of the packages needed for the project to run, make sure to run the dev version using
npm run dev
Kindly reach me peter or Omah Salah or Kholoud, etc via email or through slack for quicker response