🎶🔥 Harmoniously

quickly create faculty schedules without conflict

Background

This is the monoreposity for the Harmoniously project. The packages/ directory contains all of the package source code. All packages are available via npm.

Packages

harmoniously

Provides utilities to make scheduling easy while using constraint satisfaction techniques

install via npm:

npm i harmoniously

@harmoniously/react

React component and useHarmony hook for harmoniously

install via npm:

npm i @harmoniously/react

@harmoniously/shared

Helpers for testing in development harmoniously

install via npm:

npm i @harmoniously/shared

@harmoniously/types

Shared types for the harmoniously packages

install via npm:

npm i @harmoniously/types

API

coming soon. still a work in progress

Development

Available Scripts

npm i

Install all deps and devDeps in main repo. (Use npm run bootstrap to install all deps in packages/.)

npm run test

Run all tests in packages.

npm run bootstrap

Bootstrap the packages by installing all their dependencies and linking any cross-dependencies.

npm run build

Build all of the packages.

Used By

Calvin University