Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/amoshnin/react-university.modules.structurer

Last synced: about 5 hours ago
JSON representation

Host: GitHub
URL: https://github.com/amoshnin/react-university.modules.structurer
Owner: amoshnin
License: mit
Created: 2022-08-14T04:15:23.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2022-08-14T04:15:50.000Z (over 2 years ago)
Last Synced: 2024-05-21T05:56:38.324Z (6 months ago)
Language: TypeScript
Size: 8.47 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

[![GitHub CI](https://github.com/modtree/modtree/workflows/ci/badge.svg)](https://github.com/modtree/modtree/actions/workflows/ci.yml)
[![codecov](https://img.shields.io/codecov/c/github/modtree/modtree.svg)](https://codecov.io/gh/modtree/modtree)
![code size](https://img.shields.io/github/languages/code-size/modtree/modtree)
![version](https://img.shields.io/github/package-json/v/modtree/modtree)

Modtree is a project that seeks to leverage [existing
data](https://api.nusmods.com/v2/) 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

## Project Layout

```
├── .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
```

## Setup

After cloning, run `yarn setup` from the root of the workspace.

```
git clone [email protected]:modtree/modtree.git
cd modtree && yarn setup
```