ReportsKit Docs

This is the Rails app that generates reportskit.co, which is the documentation for ReportsKit.

If you'd like to improve this documentation, feel free to open a PR!

Installation

To set up the database locally, run the following:

rake db:setup
rake seed:migrate

Then start the Rails app:

rails s

Contributing

To help you contribute more easily, here are some navigational tips about this codebase:

• Each webpage corresponds to a Category, Subcategory, or Example.
• Each Example's content is created by either a report YML file or a Markdown file, or both.
• There is additional code in this repo that binds all of this together, but most of it doesn't need to be modified for most use cases. If you do want to modify it, you should be able to use your knowledge of Rails conventions to determine how the code is organized.

License

ReportsKit is released under the MIT License. Please see the MIT-LICENSE file for details.