Open Source Guide logo Open Source Guide

Installation and Running

You can either run InfluxDB locally or using Docker


  1. Pull the repo
  2. Install and run a local InfluxDB client
  3. cp env.local_example .env
  4. npm install
  5. npm start

Using Docker

  1. Pull the repo
  2. cp env.docker_example .env
  3. docker-compose up

(Check package.json for other builds)

Testing the Backend

  1. use curl or Postman to make requests
  2. visit http://localhost:3000/api/v1/docs to see the API documentation

To get used to the codebase, it might help to solve an issue with the “good first issue” label.