Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
baku89 committed May 8, 2024
1 parent 75b2d3b commit c8c35d5
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Kindolphin

![](public/assets/ogp.png)

The interactive GIF Webtoon viewer, which works as a progressive web app. The app is originally made for the promotion of group_inou's new single “HAPPENING”.

Designed, art directed, and implemented by [Baku Hashimoto](https://baku89.com).

## How to make it work on your local machine

### 1. Clone the repository

```bash
$ git clone https://github.com/baku89/group-inou-happening
$ cd group-inou-happening
```

### 2. Just buy their music

1. Purchase at the [group_inou's Bandcamp](https://gal-official.bandcamp.com/album/happy) then download the MP3 file.
2. Put the `group_inou - HAPPY - 03 HAPPENING.mp3` file into the `public/assets` directory.

### 3. Install dependencies and launch the app

```bash
yarn
yarn dev
```

## License

注意: [public](./public) ディレクトリ以下のファイルはGALとAC部 (c) 2024に帰属します。それ以外のファイルはMITライセンスのもとで公開されています。詳細は[LICENSE](./LICENSE)ファイルを参照してください。

Note that the assets under the [public](./public) directory is under the copyright of GAL and AC部 (c) 2024. All other files in the repository is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.

0 comments on commit c8c35d5

Please sign in to comment.