Cachet/README.md

44 lines
1.0 KiB
Markdown
Raw Normal View History

2014-11-16 22:54:08 +00:00
# Cachet
2014-11-16 22:26:08 +00:00
2014-11-16 22:54:08 +00:00
Cachet is an open source PHP status page system using the Laravel framework.
2014-11-16 22:26:08 +00:00
2014-11-16 22:29:08 +00:00
**Currently in development.** Please feel free to contribute!
2014-11-16 22:26:08 +00:00
2014-11-16 23:37:47 +00:00
## Progress
2014-11-19 13:40:21 +00:00
![Current progress](https://dl.dropboxusercontent.com/u/7323096/Cachet.png)
2014-11-16 23:37:47 +00:00
2014-11-20 17:27:01 +00:00
## Installation
See [INSTALL.md](/INSTALL.md)
## Current Features
2014-11-20 17:18:38 +00:00
- Uses SQLite/MySQL.
- Report statuses on:
+ Incidents
+ Components
- Uses Bootstrap 3 for a easy to modify, smooth layout.
2014-11-16 22:29:08 +00:00
## Goals
2014-11-16 22:26:08 +00:00
2014-11-16 22:29:08 +00:00
- [ ] Configuration:
- [ ] Individual sites.
- [ ] Colours and themes.
- [ ] Incident reporting:
2014-11-16 22:29:08 +00:00
- [ ] Manual.
- [ ] Third-party integration to automatically create incidents.
2014-11-20 17:18:38 +00:00
- [ ] RESTful API.
- [ ] Administration panel:
- [ ] Create new incidents.
- [ ] Add components.
- [ ] Report on components.
2014-11-20 17:18:38 +00:00
- [ ] Third party integration:
- [ ] Connect to third-party services and auto report using the API.
- [ ] Add components via third-party sources.
2014-11-20 17:39:59 +00:00
- [ ] Heroku Button Support [#5](/jbrooksuk/Cachet/issues/5)
2014-11-16 22:26:08 +00:00
2014-11-16 22:29:08 +00:00
# License
2014-11-16 22:26:08 +00:00
2014-11-16 22:29:08 +00:00
[MIT license](http://jbrooksuk.mit-license.org)