Adage front end

~ Use the app ~

Adage is a tool that helps you explore gene expression data and discover new insights from machine learning models. This repository contains the code for the "front end", ie the web app itself. The "back end", where the model data is loaded and then provided to the web app, can be found here.

About

This app was built with the React framework. Specifically, it was created using Create React App, a template/starting point for making React apps with minimal setup.

To edit this source code, you'll likely need to understand some fundamentals of Git, GitHub, HTML, CSS, modern JavaScript, React, JSX, Redux, the Node environment.

If you want to make changes to the behavior of this app for your own purposes and you need help, you can contact the team. If you just want to suggest a change to us, you can create an issue in this repository.

Making changes

Set up the necessary infrastructure:

1. Install Git (the system that tracks changes to the app source code)
2. Fork this repository, and clone it to your computer (so you have a local copy of the code to make your own changes to)
3. Install Node.js (the environment that tests, builds, and packages the app)
4. Install Yarn (the package manager that installs all the third party dependencies for the app)
5. Pick and install your favorite command-line interface and text editor for your operating system

In your command line, navigate to the directory where you cloned the repository. All commands listed below should be run from there.

Install the app's package dependencies:

1. Run yarn install. This may take several minutes.

Run a local test version of the app:

1. Run yarn start. This will open a new browser tab with a live preview of the app. This command continuously watches for changes in the source code, and automatically updates the preview right in the browser. Press ctrl+c (or something else, depending on your command line interface) to stop this live preview and run a different command.

Execute all included tests to see if any critical behavior of the app broke due to recent changes:

1. Run yarn test. Like the previous command, this continuously watches for changes in the source code. Press ctrl+c to stop the process and run a different command.

Build the app, ie make a bundled, optimized version of the app that can be put on a website:

1. Run yarn build.