@modernmsg/slick-ui v0.0.2-alpha.2

Slick

"Slick!" is a component library and design system developed by Modern Message, based on Material-UI

Instructions for LOCAL development

• Install slick-ui locally
  • Clone copy of repo from GitHub
    • https://github.com/modernmsg/slick-ui
    • gh repo clone modernmsg/slick-ui
  • Run yarn build:dev
    • This installs node_modules, builds the project, and runs linter and tests
  • Run yarn test or yarn lint to check for issues
  • COMING SOON: yarn storybook
• Yarn Linking
  • Because of shared dev and peer dependencies (like react and material-ui), you have to do some special things locally to point your application towards the slick-ui library for local Slick development in conjunction with your application.
  • Delete node_modules in both the slick-ui and modernmsg/client directories (or wherever your local app is)
  • run yarn install in modernmsg/client
  • run yarn link in slick-ui
  • run yarn link @slick-ui/core in modernmsg/client
  • DO NOT run yarn install again or the link may be broken and you will have to repeat these steps. You should just be able to build either or both projects from here on out.
• Hot-Reloading For ModernMsg/Client
  • Run the application in watch mode a you normally would (e.g. foreman s -f Procfile.hot etc.)
  • In the slick-ui repo, run yarn build to re-build the distributed files on file changes (you'll need to do this manually), and foreman should pick up the updates immediately and re-build the app. This is because Yarn Link is pointing to the new build in the slick repo