📺 Probably the coolest anime discovery platform around.
Clone or download

README.md

Kitsu

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


This is our meta repository. It contains our development environment and tooling.
Check out the client, server, mobile app and api docs repositories.


Server Repository Client Repository Mobile App
Build Status Code Climate Test Coverage Build Status Code Climate Test Coverage Build Status

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. The mobile app is a cross-platform native app using React Native.

You can set up your own local development environment in just a few steps.
If you prefer more detailed instructions for point 2 and 3, head over to our Setup instructions

  1. Read our short Contributing Guide
  2. Install docker
    • For Mac, check out Docker for Mac
    • For Windows, check out Docker for Windows
    • For Linux, manually install docker and docker-compose via your repository's package manager
  3. Run bin/setup and follow the instructions. (This will also validate your docker installation)
  4. Follow the quick Filling the Database guide for getting some data to play with

If you have any questions don't hesitate to contact us! Feel free to 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 feature request on Kitsu.

Screenshots

Library Page Profile Page Browse Page Preview Modal Dashboard Page

License

Copyright 2017 Kitsu, 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.