Giter VIP home page Giter VIP logo

annict's Introduction

Annict

Travis CI Code Climate Coveralls Gemnasium Slack Waffle

開発に参加する

新機能・改善案の話やバグの話など

開発に関するもろもろのやり取りは、以下のサービスで行っています。

セキュリティに関わるバグの報告

[email protected] までメールをください。 Twitterなど、第三者に公開されている場所に投稿しないでもらえるとありがたいです。

Pull Requests

絶賛募集中です!以下の項目を守った上で送ってもらえると嬉しいです。

  • コーディング規約を意識したコードを書いてください
  • 新たに機能を追加したときはそのテストも追加してください
  • 既存のテストを全てパスすることを確認してください

タスク管理について

Annictでは開発に関係するタスク管理をWaffleで行っています。 各タスクは以下のリストで管理しています。

リスト名 概要
Just An Idea システム内に取り込むことが決定していない漠然としたタスク
TODO システム内に取り込むことが決定したタスク
In Progress 現在取り組んでいるタスク
Done 作業が完了したタスク

「TODO」リストの上から順に優先度が高いタスクとなっています。

開発環境を作る

必要なものをインストールする

Annictは以下のソフトウェアを使用して開発しています。 Annictを動かすには事前にこれらをインストールする必要があります。

  • Ruby 2.3
  • PostgreSQL 9.5
  • ImageMagick
  • Node.js 0.12
  • PhantomJS
    • テストを実行するときに使用しています。Annictをローカルで動かすだけであれば不要です
Annictを動かす

GitHubからソースコードをcloneしてから以下のコマンドを実行してください。

$ cd annict
$ cp config/application.yml{.example,}
$ bundle
$ rake db:setup
$ npm install
$ rails s -b 0.0.0.0

http://localhost:3000 にアクセスすると、 サイトのトップページが表示されるはずです。

ただ、上記コマンドを実行しただけでは作品画像などは表示されないはずです。 画像を表示するには「Tombo」という画像変換サーバを別途起動する必要があります。

画像変換サーバ「Tombo」について

Annictでは作品やアバターなど画像を表示するとき、 「Tombo」という画像を動的にリサイズする画像変換サーバを使用しています。 動かし方などはTomboのリポジトリをご覧ください。

AnnictでTomboを使用するときは localhost:5000 でサーバを起動します。

application.ymlを編集する

AnnictのRailsアプリに必要な設定値は全て config/application.yml に記述しています。 開発環境でも必要に応じて設定を変更する必要があります。

例えばTwitterアカウントを使用してローカル環境でユーザ登録をしたいときは、 TwitterでOAuth認証用のアプリを作成し、config/application.yml に記述されている TWITTER_CONSUMER_KEYTWITTER_CONSUMER_SECRET を変更します。

テストを実行する

以下のコマンドでテストが実行できます。

$ rspec

ライセンス

Copyright 2014-2016 Annict

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

annict's People

Contributors

deppbot avatar flada-auxv avatar greenkeeperio-bot avatar henriquebremenkanp avatar koic avatar kunitoo avatar polamjag avatar racion avatar shimbaco avatar takuan-osho avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.