Data Dashboard

A dashboard and debugger for our data hub

This dashboard is part of a broader project meant to aggregate and inter- connect data from AIC's various systems into a single API. It will offer a GUI for exploring aggregated data, visualizations, and monitoring capabilities.

This dashboard was built in-house and is maintained by in-house developers. It is planned to go to production in 2017.

Overview

This dashboard is part of a larger project at the Art Institute of Chicago to build a data hub for all of our published data--a single point that our forthcoming website and future products can access all the data they might be interested in in a simple, normalized, RESTful way.

Requirements

We've run this on our local machines with the following software as minimums:

Installing

To get started with this project, use the following commands:

# Clone the repo to your computer
git clone https://github.com/art-institute-of-chicago/data-dashboard.git

# Enter the folder that was created by the clone
cd data-dashboard

# Commands to get `grunt` to run
nvm use 14
npm install -g grunt-cli
gem install sass

# Install all the project's NPM dependencies
npm ci

# Run grunt
grunt

Contributing

We encourage your contributions. Please fork this repository and make your changes in a separate branch. To better understand how we organize our code, please review our version control guidelines.

# Clone the repo to your computer
git clone git@github.com:your-github-account/data-service-collections.git

# Enter the folder that was created by the clone
cd data-aggregator

# Run the installs
composer install

# Start a feature branch
git checkout -b feature/good-short-description

# ... make some changes, commit your code

# Push your branch to GitHub
git push origin feature/good-short-description

Then on github.com, create a Pull Request to merge your changes into our develop branch.

This project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

We also welcome bug reports and questions under GitHub's Issues. For other concerns, you can reach our engineering team at engineering@artic.edu

Licensing

This project is licensed under the GNU Affero General Public License Version 3.