README.md 2.15 KB
Newer Older
1
2
# cState

3
[![Discord](https://img.shields.io/badge/discord-join%20chat-7289DA.svg?style=flat-square)](http://discord.io/choraleapp)  [![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)  [![Twitter](https://img.shields.io/twitter/follow/choraleapp.svg?style=social&label=Follow)](https://twitter.com/polargalaxymc)
4

5
> Blazing fast status page with excellent browser support. Built with Hugo. Work in progress, may have bugs and incomplete features.
6
7
8

Is [statuspage.io](https://www.statuspage.io/) too expensive? Do you need an open source alternative for your project that is supported on archaic browsers like IE8 and never stops beating? cState is here to help.

9
[Live demo](https://status.choraleapp.com)
10

11
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/mistermantas/cstate)
12
13
14
15
16

## Usage

To set up cState, do the following:

17
1. Deploy the status page, preferably using [Netlify](https://app.netlify.com/start/deploy?repository=https://github.com/mistermantas/cstate) and/or [GitHub Pages](https://pages.github.com).
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
2. Upload your favicon and logo to `/static/` and edit `config.yml`.

Once that is done, you can create a new post like this:

```
hugo new incident/dns-killed-us.md
```

Then, go into `incident/dns-killed-us.md` and follow this format:

```md
---
Title: Catastrophic DNS failure
Description: After moving from one server to another, some DNS settings had unknowingly been tweaked which caused a complete outage for everything hosted on our domain.
Date: 2017-04-04T15:58:32
Section: post
---

##### Post-mortem

On Monday, Amazon gave up on us.
```

## Features

+ Built with [Hugo](https://gohugo.io), on a sturdy foundation
+ Works everywhere: all modern browsers, even IE8 and later
+ You can subscribe to web notifications for status updates
+ Simple, focused, and robust design
+ Easy to edit and deploy

## Resources

51
52
+ [Issue tracker](https://github.com/mistermantas/cstate)
+ [Code repository](https://github.com/mistermantas/cstate)
53
54
55
56

## License

MIT © Mantas Vilčinskas