trumptracker.github.io/README.md
2017-05-14 15:27:20 +02:00

47 lines
2.8 KiB
Markdown

# Trump Tracker
[![Travis](https://img.shields.io/travis/TrumpTracker/trumptracker.github.io.svg?style=flat-square)](https://travis-ci.org/TrumpTracker/trumptracker.github.io) [![license](https://img.shields.io/github/license/TrumpTracker/trumptracker.github.io.svg?style=flat-square)](https://github.com/TrumpTracker/trumptracker.github.io/blob/master/LICENSE.md) [![Gitter](https://img.shields.io/gitter/room/TrumpTracker/trumptracker.github.io.svg?style=flat-square)](https://gitter.im/trump-tracker/Lobby) [![RSS](https://img.shields.io/badge/RSS-v2.0-brightgreen.svg?style=flat-square)](https://luithollander.nl/trumptracker/rss.php)
# Setup
Install [Jekyll](https://jekyllrb.com/) and Bundler:
gem install jekyll bundler
bundle install
rake serve
Site is now running at [localhost:4000](http://localhost:4000)
# Tests
rake test
# Contributing
We'd love to get contributions from you! For a quick guide to getting your system setup for developing TrumpTracker take a look at the setup above. Once you are up and running, check out the [contributing guide](.github/PULL_REQUEST_TEMPLATE.md) to see how to get your changes and pull requests merged in.
# To Do List
1. Add Spanish Version
2. ~~Cleaner way to add and handle policies (not hardcode it...)~~
3. ~~Fuzzy Search functionality for policies~~
4. ~~Comment section -- Reddit Integration (might be too toxic)~~
5. Sign up for weekly/ bi-weekly updates when his term begins.
6. ~~Database for Policies -- top of the agenda~~
7. ~~Add Open Source Links and Credits on Footer~~
8. ~~Clean up duplicates, if any.~~
9. ~~Implement functionality to let me click on the "broken", "in progress", "achieved" categories so I can see which things fall into those categories.~~
10. Implement http://schema.org/? on all policy pages
11. ~~Add tweet button #47~~
# Also check
- [TrumpTracker RSS](https://github.com/TrumpTracker/RSS) - An RSS feed of all changes in the database file (PHP)
- [TrumpTracker RedditBot](https://github.com/TrumpTracker/RedditBot) - A bot that creates a new Reddit thread for every addition to the database (PHP)
- [TrumpTracker AutoTwitterHeart](https://github.com/TrumpTracker/AutoTwitterHeart) - Automatically like tweets which mention a specific hashtag or username (Ruby)
- [YourTracker](https://github.com/TrumpTracker/YourTracker) - Make your own TrumpTracker with this command line interface (Node.JS)
# Report Issues
1. Create a [pull request](https://github.com/TrumpTracker/trumptracker.github.io/pulls) or create an [issue](https://github.com/TrumpTracker/trumptracker.github.io/issues)
2. Message the Reddit mods at [/r/trumptracker](https://www.reddit.com/message/compose?to=%2Fr%2Ftrumptracker)
3. Send a message on [Gitter](https://gitter.im/trump-tracker/Lobby)
4. Otherwise you can fill out [the typeform](https://viren8.typeform.com/to/CA1RiV?)