harmoniously
v0.2.4
Published
๐ถ๐ฅ utilities for quickly create faculty schedules without conflict
Downloads
84
Readme
harmoniously
Provides utilities to make scheduling easy while using constraint satisfaction techniques.
Use
install via npm:
npm i harmoniously
API
Coming Soon
Commands
TSDX scaffolds your new library inside /src
.
To run TSDX, use:
npm start
This builds to /dist
and runs the project in watch mode so any edits you save inside src
causes a rebuild to /dist
.
To do a one-off build, use npm run build
.
To run tests, use npm test
.
Configuration
Code quality is set up for you with prettier
, husky
, and lint-staged
. Adjust the respective fields in package.json
accordingly.
Jest
Jest tests are set up to run with npm test
or yarn test
.
Bundle Analysis
size-limit
is set up to calculate the real cost of your library with npm run size
and visualize the bundle with npm run analyze
.
Continuous Integration
GitHub Actions
Two actions are added by default:
main
which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrixsize
which comments cost comparison of your library on every pull request usingsize-limit