https://github.com/shimabox/mizu-ts
Mizu-ts is a joke script that simulates water(H2o) generation in TypeScript.
https://github.com/shimabox/mizu-ts
Last synced: about 2 months ago
JSON representation
Mizu-ts is a joke script that simulates water(H2o) generation in TypeScript.
- Host: GitHub
- URL: https://github.com/shimabox/mizu-ts
- Owner: shimabox
- Created: 2025-01-08T11:04:36.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-01-19T09:43:24.000Z (3 months ago)
- Last Synced: 2025-01-19T10:28:31.939Z (3 months ago)
- Language: TypeScript
- Size: 43.3 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mizu-ts
Mizu-ts is a joke script that simulates water(H2o) generation in TypeScript.
> [!NOTE]
> A TypeScript port of [Mizu](https://github.com/shimabox/Mizu), originally written in JavaScript.
## 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.
- [x] Hを描画
- [#2](https://github.com/shimabox/Mizu-ts/pull/2)
- v0.2.0
- [x] Hをたくさん描画
- [#3](https://github.com/shimabox/Mizu-ts/pull/3)
- v0.3.0
- [x] Hを動かす
- [#4](https://github.com/shimabox/Mizu-ts/pull/4)
- v0.4.0
- [x] HがぶつかったらH2にする
- [#5](https://github.com/shimabox/Mizu-ts/pull/5)
- v0.5.0
- Fixed bug.
- [#7](https://github.com/shimabox/Mizu-ts/pull/7)
- [x] Oを描画
- [#6](https://github.com/shimabox/Mizu-ts/pull/6)
- v0.6.0
- [x] H2とOがぶつかったらH2oにする
- [#8](https://github.com/shimabox/Mizu-ts/pull/8)
- v0.8.0
- [x] GitHub Pages へのデプロイ
- https://github.com/shimabox/Mizu-ts/releases/tag/v0.7.1
- [x] 計測処理実装
- https://github.com/shimabox/Mizu-ts/pull/9
- [ ] 改善(interfaceを利用した実装にする, リファクタなど)
## Prerequisites
- Node.js >= 18.0.0
- npm >= 9.0.0
[Volta](https://volta.sh/) is a convenient tool for managing Node.js and npm versions:
```sh
# 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**
```sh
brew install graphviz
```
**linux**
```sh
# Ubuntu/Debian
sudo apt install graphviz
# Fedora
sudo dnf install graphviz
```
[Official Graphviz download page](https://www.graphviz.org/download/#linux).
**Windows**
Download the installer from the [official Graphviz download page](https://www.graphviz.org/download/#windows), and follow the setup instructions.
## Installation
```sh
# 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
```sh
npm run dev
```
### Production Build
```sh
npm run build
```
### Preview Production Build
```sh
npm run preview
```
### Lint Code
```sh
npm run lint
```
### Format Code
```sh
npm run format
```
### Run Tests
```sh
npm run test
```
### Check Test Coverage
```sh
npm run coverage
```
### Analyze Dependencies
```sh
npm run depcruise
```
### Generate Dependency Graph
This command generates `dependency-graph.svg` in the project root.
```sh
npm run dependency-graph
```