README
conveyor
Frontend libraries for building an AutoInvent application
Packages
- conveyor - A frontend dashboard generator for inventory data.
- conveyor-redux - Generates reducers and epics for use with conveyor
- conveyor-schema - A schema helper library for conveyor
- magql-query - Query builder and request tool for communicating with a magql backend.
Development
Packages are managed using rush. Ensure rush is installed:
npm install --global @microsoft/rush
Then install, build, and lint:
rush update
rush build
rush lint
You should run "rush update" whenever you start working in the repo, after you pull from Git, and after you modify a package.json file. If there is nothing to do, "rush update" is instantaneous.
Adding a dependency to a package
cd packages/some-pkg
rush add --package ramda
rush add --package @types/ramda --dev
- Manually updating the package.json and running
rush updatewill also work. - Hint: Adding the flag
-mor--make-consistentwill cause other packages using this dependency to use the same version
TODO
- git commit-msg hook enforcing conventional commits
- git pre-commit hook which runs prettier
- github action for labeling pull requests based on the paths of the files changes: https://github.com/actions/labeler
- lint on build (
rush build) - lint bulk command (
rush lint) - ci using github actions
- build
- integrate
rush change --verify
- investigate publishing public packages: https://rushjs.io/pages/maintainer/publishing/
- consolidate dev dependencies using rigs
- investigate automatically creating releases from PRs / commits? (https://github.com/semantic-release/semantic-release#-semantic-release)
- more...