Skip to content

mtna/rds-js-examples

Repository files navigation

RDS - JS - Examples

WARNING: THIS PROJECT IS IN EARLY DEVELOPMENT STAGE. CONTENT OR CODE SHOULD ONLY BE USED FOR TESTING OR EVALUATION PURPOSES.

Travis (.com) branch Coveralls github branch GitHub Snyk Vulnerabilities for GitHub Repo semantic-release code style: prettier

Covid-19 demo app Edit the source code Various visualizations
example-app code-editor visualizations

Rich Data Services (or RDS) is a suite of REST APIs designed by Metadata Technology North America (MTNA) to meet various needs for data engineers, managers, custodians, and consumers. RDS provides a range of services including data profiling, mapping, transformation, validation, ingestion, and dissemination. For more information about each of these APIs and how you can incorporate or consume them as part of your work flow please visit the MTNA website.

RDS-JS-Examples is TypeScript/JavaScript repository for showcases and examples to demonstrate using the RDS API. Many of the examples will leverage the RDS JavaScript SDK to simplify and faciliate interacting with any given RDS API. By using this SDK you will add to your project the benefit of strong types and easy to use helper functions that directly reflect the RDS API.

Be sure to checkout the sdk source code and documentation.

References

RDS JavaScript SDK RDS API Documentation RDS Contributing Developer Documentation Changelog

Quick start

  1. Clone this repository and navigate into the directory.
  2. Install dependencies
    npm i
  3. Run the application on a local development server
    npm start
    
    Open your browser to http://localhost:4200

Development

This repository leverages a few technologies to make development simple.

Running npm start will compile TypeScript and Sass files, combine html partials (via posthtml-include) and serve on http://localhost:4200. It will watch for file changes and automatically rebuild and refresh the page on save.

Build

Production builds are simple thanks to Parcel. Just run npm run build and the compiled output will be placed in the /dist directory.

Contribute

Putting this product together and maintaining the repository takes time and resources. We welcome your support in any shape or form, in particular:

  • Fork/clone, and contribute to the package
  • Let us know is you find any discrepancy or have suggestions towards enhancing the content or quality of the library
  • Buy us a beer/coffee! Donations are appreciated and can be made through PayPal
  • Consider using RDS or any of our data/metadata services, products, or expertise