ojosama-web

ojosama-web copied to clipboard

= ojosama-web :sectnums: :toc: left

テキストを壱百満天原サロメお嬢様風の口調に変換するWebアプリです。

image:./docs/demo.gif[]

== お知らせ (2022/10/16)

https://blog.heroku.com/next-chapter[Heroku無料プランの廃止]に伴って、サイトのURLを変更しました。 変更内容は以下のとおりです。

• サイトURL ** 旧 https://ojosama.herokuapp.com ** 新 https://ojosama.jiro4989.com
• API URL ** 旧 https://ojosama.herokuapp.com/api/ojosama ** 新 https://api.ojosama.jiro4989.com

旧サイトURLは2022/10/16に廃止したため、 お手数ですがブラウザブックマークや、APIを使っている方はURLを変更してください。

== 概要

テキストを壱百満天原サロメお嬢様風に変換する自前のライブラリ https://github.com/jiro4989/ojosama[ojosama] を使って作ったWebアプリです。

実行環境は AWS です。以下URLからアクセスできます。

• https://ojosama.jiro4989.com

== 壱百満天原サロメお嬢様について

以下を参照してください。

• https://www.nijisanji.jp/members/salome-hyakumantenbara[壱百満天原サロメ - にじさんじ公式サイト]
• https://twitter.com/1000000lome[壱百満天原サロメ - Twitter]

== 使い方

=== Web

「入力」にテキスト入れて「変換」ボタンを押すだけです。

=== API

APIとしても使えるようにしてます。

[source,bash]

$ curl -X POST -H 'Content-Type: application/json' -d '{"Text":"これはハーブです！"}' https://api.ojosama.jiro4989.com {"Result":"これはおハーブですわ～！"}

API仕様は以下資料を確認してください。

• https://jiro4989.github.io/ojosama-web/swagger.html

== 動作環境

最低限以下の環境で動作確認をしています。

• PC ** Google Chrome 最新
• Android ** Google Chrome 最新

それ以外の環境は動作確認していませんが、 素のHTMLとJSと単純なCSS設定しかしていないので多分動くと思います。(淡い期待) まぁ多少レイアウトが崩れていても変換機能は動くはずなので許してください。

なお、Internet Explorerはサポート外です。

== 注意事項

=== プログラムの使用について

壱百満天原サロメお嬢様、及びその所属の にじさんじ や、 その関係者、ファンコミュニティの方の迷惑にならないように使ってください。

本プログラムは、にじさんじ所属の壱百満天原サロメお嬢様のキャラクターを題材にした二次創作の一つです。 故に、本プログラムは以下二次創作ガイドラインに従います。

• https://event.nijisanji.app/guidelines/[ANYCOLOR二次創作ガイドライン]

本プログラムを使う場合も上記ガイドラインを守ってお使いください。

== 開発者向け

=== アプリ構成

バックエンドはGoで実装しています。

フロントエンドは素のHTMLとJSだけで書いています。 依存パッケージ管理が面倒なので、npmを導入する予定はありません。

フロントからはJSでAPIリクエストを出して、結果を貼り付けてるだけです。

それぞれのソースコードは以下のディレクトリで管理します。

[options="header"] |================= | 役割 | ディレクトリ名 | バックエンド | ojosama-api | フロントエンド | ojosama-assets | インフラ | 非公開リポジトリ |=================

=== インフラ構成

インフラは AWS を利用しています。

インフラの設定は AWS CDK (TypeScript) でコード管理しています。 このコードは非公開リポジトリで管理しています。

システム構成は以下のとおりです。

image:./docs/system.png[]

=== デプロイ

AWS CodeBuild で更新します。 CodeBuild でのビルド処理は buildspec.yml に記述します。

main ブランチが更新されると自動でバックエンドとフロントエンドが更新されます。

=== Pull Request

壱百満天原サロメお嬢様チックな画面デザインは @Shinaco1992 さんが改良してくださいました。 (https://github.com/jiro4989/ojosama-web/pull/10[#10]) ホントにホントに感謝です。

リポジトリオーナー(次郎)はデザインもCSSもさっぱり分からないので、UI改善PRを大変嬉しく思います。

UIに限らず、いろんなPRを快く受け入れますので、皆様のPRをお待ちしてます。