Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 3.4 KB

README.md

File metadata and controls

65 lines (41 loc) · 3.4 KB

Hummingbird

Build Status Code Climate Coverage


This branch is our under-development next-generation platform, not the one currently at hummingbird.me


Hummingbird is now Open Source

What is Hummingbird?

Hummingbird is a modern anime discovery platform that helps you track the anime you're watching, discover new anime and socialize with other fans.

Contributing

The backend is a JSON API server built with Rails, Postgres, ElasticSearch, and Redis. The frontend is a client-side application written using Ember.

To get started, clone this repository, install Docker (via Docker for Mac/Windows or Docker-Machine if you're not on Linux) and run bin/setup && bin/start to get a development version running. Before you start working be sure to read the contribution guide.

To get data into your development server:

  1. Download our media database dump

  2. Import the dump to your database:

    gzcat anime.sql.gz | bin/psql hummingbird_development
    
  3. Set up Elasticsearch:

    bin/rake chewy:reset`
    

If you have any questions don't hesitate to contact us! Feel free to create a topic in the forum dev category or email Josh to get access to our Slack.

For ideas of things to do, see our GitHub issues — check out the issues tagged "easy" for a good starting place!

Please don't use Github issues for feature requests, instead create a topic in the forum feedback category.

Screenshots

Library Page Profile Page Browse Page Preview Modal Dashboard Page

License

Copyright 2015 Hummingbird Media, Inc.

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.