Skip to content

Latest commit

 

History

History
186 lines (130 loc) · 3.76 KB

README.md

File metadata and controls

186 lines (130 loc) · 3.76 KB

Mizu-ts

Mizu-ts is a joke script that simulates water(H2o) generation in TypeScript.

Mizu-ts

Note

A TypeScript port of Mizu, originally written in JavaScript.

Dependency Graph

Dependency Graph

Demo

https://shimabox.github.io/Mizu-ts/

Debug

https://shimabox.github.io/Mizu-ts/?m=1&h=60&o=100

key default type description
m 0 number Show measurement if set to 1
h 30 number Number of H to generate
o 50 number Number of O to generate

TODO

Fixed.
  • 改善(interfaceを利用した実装にする, リファクタなど)

Prerequisites

  • Node.js >= 18.0.0
  • npm >= 9.0.0

Volta is a convenient tool for managing Node.js and npm versions:

# Install Volta
curl https://get.volta.sh | bash

# Install Node.js and npm
volta install node@18

Graphviz (For Dependency Visualization)

For dependency visualization, dependency-cruiser is used. To generate visual graphs, you need to install Graphviz.
Follow the steps below to install it.

macOS

brew install graphviz

linux

# Ubuntu/Debian
sudo apt install graphviz

# Fedora
sudo dnf install graphviz

Official Graphviz download page.

Windows

Download the installer from the official Graphviz download page, and follow the setup instructions.

Installation

# Clone the repository
git clone https://github.com/shimabox/Mizu-ts.git

# Navigate to the project directory
cd Mizu-ts

# Install dependencies
npm install

Usage

Start Development Server

npm run dev

Production Build

npm run build

Preview Production Build

npm run preview

Lint Code

npm run lint

Format Code

npm run format

Run Tests

npm run test

Check Test Coverage

npm run coverage

Analyze Dependencies

npm run depcruise

Generate Dependency Graph

This command generates dependency-graph.svg in the project root.

npm run dependency-graph