turnilo

(β˜… 769)

Business intelligence, data exploration and visualization web application for Druid, formerly known as Swiv and Pivot

  • .dockerignore
  • .gitignore
  • .npmignore
  • .npmrc
  • .npmrc-publish
  • .release-it.json
  • .sass-lint.yml
  • babel.config.js
  • CODEOWNERS
  • config-examples.yaml
  • CONTRIBUTING.md
  • cypress.config.ts
  • Dockerfile
  • LICENSE
  • lighthouserc.js
  • NOTICE
  • package-lock.json
  • package.json
  • README.md
  • tsconfig.json
  • tslint.json

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/allegro/turnilo

Downloads the entire project code from GitHub to your computer.

cd turnilo

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Node.js Node.js must be installed to use npm.
npm install -g turnilo

Installs the package published on the npm registry globally β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t turnilo .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 turnilo

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install -g turnilo

Installs the package published on the npm registry globally β€” no need to clone the source.

npm install

Downloads and installs the libraries listed in package.json.

npm run build

Builds optimized production files.

npm run start:examples

Starts the development/run server.

npm run start -- connect-druid http[s]://druid-broker-hostname[:port]

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

5. Ruby

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Ruby Ruby is required to use the bundle command.
cd docs

This project's files live in a subfolder, so move into it first.

bundle install

Installs the Ruby libraries listed in the Gemfile.

βœ… If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).
// repository documentation