Code Monkey home page Code Monkey logo

insights-client's Introduction

Insights Client Library

Copyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md for license terms and full copyright notice.

iTwin.js is an open source platform for creating, querying, modifying, and displaying Infrastructure Digital Twins. To learn more about the iTwin Platform and its APIs, visit the iTwin developer portal.

If you have questions, or wish to contribute to iTwin.js, see our Contributing guide.

About this Repository

Contains the @itwin/insights-client package that wraps sending requests to the reporting service. Visit the Insights API and Carbon calculation API for more documentation on the insights service.

Environment Variables

Optional URL prefix for dev/qa environments

IMJS_URL_PREFIX=""

Authorization for running tests

  • Create .env file and configure the following variables:
TEST_PROJECT_NAME=
TEST_IMODEL_NAME=
AUTH_AUTHORITY=
AUTH_CLIENT_ID=
AUTH_CLIENT_SECRET=
AUTH_REDIRECT_URL=
APIS_IMODELS_BASE_URL=
APIS_IMODELS_VERSION=
APIS_IMODELS_SCOPES=
APIS_PROJECTS_BASE_URL=
APIS_PROJECTS_SCOPES=
TEST_USERS_ADMIN1_EMAIL=
TEST_USERS_ADMIN1_PASSWORD=
TEST_USERS_ADMIN2_FULLY_FEATURED_EMAIL=
TEST_USERS_ADMIN2_FULLY_FEATURED_PASSWORD=
TEST_BEHAVIOR_OPTIONS_RECREATE_IMODEL=
  • Test project and imodel will be created automatically with provided names.
  • You can then run npm run test:integration.
  • There are currently no tests for oneClickLcaClient

Build Instructions

Install dependencies and build source

npm install
npm run build

Run tests

npm run test

Run linters

npm run lint

Helper files

.githooks

  • copyright-linter

    To use custom hooks, run the command:

    git config --local core.hooksPath .githooks/
    

insights-client's People

Contributors

bingjiez avatar guillar1 avatar rytissapka avatar dependabot[bot] avatar friedliver avatar lzaromskis avatar arnobmallickbsw avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.