Modtree is a project that seeks to leverage existing data in a graph-oriented visualization tool in order to:
- Increase clarity in degree planning
- Allow students to efficiently experiment with different degree paths
- Minimize mental overhead and time spent to source for degree data
- Improve module information accessibility
├── .github/workflows automated testing/deployments
│
├── apps user-facing apps
│ ├── web website (frontend)
│ ├── server API server (backend)
│ └── docs documentation website
│
├── libs shared resources
│ ├── types types, interfaces, and TypeORM entities
│ ├── repos backend functions (TypeORM Repositories)
│ ├── utils shared utilities
│ ├── typeorm-config TypeORM database connection configuration
│ ├── test-env common test setups (mostly Jest)
│ ├── integration-tests tests that require a running database
│ ├── migrations schema migration checker, generator, and runner
│ └── sql SQL commands piped through TypeScript
│
├── scripts helper scripts
├── docker dockerfiles and scripts
└── references JSON exports of database views
After cloning, run yarn setup from the root of the workspace.
git clone git@github.com:modtree/modtree.git
cd modtree && yarn setup