Skip to content

Dev notes

Carl Shen edited this page Jun 9, 2020 · 14 revisions

Prerequisites (Dev Env)

  • brew? -> yarn

  • yaas needs python3 and flask and ...

Development

  • .github/CODEOWNERS file ... I forget what exactly being an owner gets you.
  • maybe set upstream of rich-markdown-editor to outline/rich-markdown-editor

Run locally (at localhost:3000)

  • yarn start

Local Editor

  • remove react (and react-dom?) from devdependencies in rich-markdown-editor package.json ... (to run example in the repo, if desired, add them back in)
  • yarn build in the rich-markdown-editor repo/root
  • yarn add path/to/local/rich-markdown-editor or change in package.json in the yada repo/root
  • (yarn install? if changed package json instead of yarn add)
  • (yarn upgrade rich-markdown-editor? to make sure no "multiple versions" issue if needed)

Deploy (to fydp-saac.github.io/yada)

  • yarn deploy

Based on https://gist.github.com/vre2h/da9db3733c238c174d13670fb77c1f1a

Note: use yarn instead of npm

  • yarn add = npm install
  • yarn install = ...
  • yarn upgrade = ...
  • yarn build = ...

Create-React-App

Some other info here from Create-React-App bootstrapped docs: https://github.com/fydp-saac/yada/blob/master/README_bootstrapping.md

Relevant links