Git Product home page Git Product logo

signature-commons-ui's Introduction

signature-commons-ui

A front-end UI for demoing API integration. Currently available at: http://amp.pharm.mssm.edu/sigcom/

Development

Before starting, install the project dependencies:

npm install

npm run dev

Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm run export:[dev|production]

Build and export the project as a series of .html files.

npm run deploy:[dev|production]

Export, build and deploy the docker image for release.

dotenv

We use dotenv / next-dotenv to organize loading of environment variables--more specific settings will override less specific ones. i.e. .env.development settings take precedent over .env. You should define your own .env.*.local which are hidden by git (see dotenv-load).

Furthermore, environment prefixes are important for NextJS.

  • NEXT_PUBLIC_*: available server / client side
  • NEXT_SERVER_*: available server side only
  • NEXT_STATIC_*: available during static rendering

Other variables may not propagate, so ensure you use these prefixes.

UI SCHEMAS

Modifying SigCom UI to your data is done via the entries in the schema table. SigCom uses three types of schemas.

  • /dcic/signature-commons-schema/v5/meta/schema/landing-ui.json: Defines the overall look of the landing page
  • /dcic/signature-commons-schema/v5/meta/schema/ui-schema.json: Used for formatting the labels for searches, without this, SigCom defaults to the ids as labels
  • /dcic/signature-commons-schema/v5/meta/schema/counting.json: Tells sigcom which metadata to count for the landing page, you can also set it to either be a pie chart, a bar chart, or a regular count|

For more information check Modifying UI and the examples folder. Also, check UI_values

signature-commons-ui's People

Contributors

jeevangelista avatar u8sand avatar dependabot[bot] avatar avimaayan avatar

Watchers

James Cloos 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.