1.0.4 • Published 4 years ago

curastory-ui-shared-1 v1.0.4

Weekly downloads
3
License
ISC
Repository
github
Last release
4 years ago

Curastory UI Shared Repo Library

:warning: Before utilize this repo in your UI repo, ssh key is setup in github to be able to download the shared repo into the node_modules

Setting Up

Installing NVM

  • Follow steps here to install node version manager: NVM
  • Install node 10.15.x(preferably 10.15.3) nvm install 10.15.3
  • Set to installed node version nvm use 10.15.3

Installing Dependencies

  • yarn to install packages

Working In Repo

Build Typescript Files

  • To build changes in Typescript files run yarn tsc
  • To watch for changes, and build Typescript files on any save, run yarn watch

Linking Locally

This would allow you to use the local version of the shared repo checked out on your machine for your UI project during the development phase

  • Cd into directory where this repo lives on your terminal and run yarn link
  • Now, cd into the directory of your UI repo(web, mobile, etc.) that is consuming this repo and run yarn link curastory-ui-shared
  • To break the local link, inside your UI repo run yarn unlink curastory-ui-shared