NuitaはRuby on Rails製の射精報告SNSです。
LinuxやMac上であれば、あなたのPC上でNuitaを動かすことができます。
ただし、事前に以下のものをインストールしておく必要があります。
- Ruby 2.7.2
- MySQL 5.7.30
- Yarn
- このレポジトリをクローンし、ディレクトリに移動します。
$ git clone git@github.com:nuita/nuita.git
$ cd nuita
- Nuitaのコードがあるディレクトリに入り、必要な依存をインストールします。
$ bundle install
$ yarn install --check-files
- データベースをセットアップします。
$ bundle exec rails db:setup
手元のMySQLにパスワードを設定している場合、config/database.ymlのdevelopmentに自分のパスワードを追記する必要があるかもしれません。
- Nuitaを立ち上げます。
$ bundle exec rails s
ブラウザにlocalhost:3000にアクセスして、かわいいチノちゃんの画像が表示されていたら成功です!
（環境変数PORT, HOSTを指定することでホストやポート番号は変更することができます）
Docker上でもNuitaを起動させることができます。
手元の環境を汚したくないあなたにおすすめです。
- このレポジトリをクローンし、ディレクトリに移動します。
$ git clone git@github.com:nuita/nuita.git
$ cd nuita
- コンテナ上で依存関係をインストールします。
$ docker-compose run --rm app sh -c 'bundle install && yarn install --check-files'
- コンテナ上でデータベースをセットアップします。
$ docker-compose run --rm app bundle exec rails db:setup
- Nuitaを立ち上げます。
$ docker-compose up
ブラウザにlocalhost:3000にアクセスして、かわいいチノちゃんの画像が表示されていたら成功です!
プルリクエスト・イシュー・コードレビュー等大歓迎です!
新たな機能を追加した場合は、このレポジトリをフォークした上で、自分のレポジトリからこのレポジトリのmasterブランチに向けてプルリクエストを出してください。
Github Actionsによって自動的にテストが走ったあと、問題なさそうであればレビューを行った上でマージされます。
- NuitaにURIを投稿した際に取得・表示されるデータはPanchiraというgemによるものです。
- 対応するサービスを増やしたい・誤ったデータを修正したい場合は、上掲したレポジトリにリクエストしてください。