1.0.0-5 • Published 6 years ago

contiamo-labs-ui v1.0.0-5

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

Labs UI

This project will serve as the UI for the Labs platform.

Current Status: 🚧 in development 🚧

Please check out the open issues to see how you can help, or track progress by examining the current milestone.

Getting Started

Prerequisites

Because of authentication and cookie access, you're expected to have your HOSTS file point the web address labs-dev.ctmo.io to 127.0.0.1. To do this, simply follow the steps below:

  • sudo nano /etc/hosts
  • Type your password and hit enter
  • Add 127.0.0.1 labs-dev.ctmo.io
  • Press ^O or Control-O
  • Press ^X
  • 🎉

The Regular

  • git clone git@github.com:Contiamo/labs-ui.git
  • yarn install
  • yarn start

From here, you'll want to open up the project in your favorite editor and explore the application flow starting at ./src/index.tsx. Following the dependency graph and comments, you should be able to make sense of how it works.

Potential Gotcha: React Version

This project uses React@14-alpha currently. yarn or npm may have issues resolving the version deterministically when you run either package manager's install command, in which case manually running yarn add react@next should do the trick. ¯\_(ツ)_/¯

Building for Production

Building for production creates a dist folder that contains the production-ready assets. To invoke a production build, simply run yarn build.