README.md 2.47 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

Mantas's avatar
Mantas committed
13
## Table of Contents
14

Mantas's avatar
Mantas committed
15
16
17
18
19
20
+ [Features](#features)
+ [Installation](#installation)
  + On Netlify
  + GitHub Pages
+ [Contribute](#contribute)
+ [License](#license)
21

Mantas's avatar
Mantas committed
22
23
24
25
26
27
28
29
30
31
32
33
34
## 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

## Installation

### On Netlify

1. [Deploy to Netlify](https://app.netlify.com/start/deploy?repository=https://github.com/mistermantas/cstate).
35
36
2. Upload your favicon and logo to `/static/` and edit `config.yml`.

Mantas's avatar
Mantas committed
37
38
39
40
41
42
43
### Everywhere Else



## Creating Incident

Once in the project root directory, you can create a new post from the command line like this:
44
45
46
47
48

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

Mantas's avatar
Mantas committed
49
50
Essentially, just go into `content/incident` and add a new file. This will be an incident. The file name will indicate the URL of the incident. So, for example, if you create `dns-killed-us.md`, the URL will lead to `status.example.com/incident/dns-killed-us`.

51
52
53
54
55
Then, go into `incident/dns-killed-us.md` and follow this format:

```md
---
Title: Catastrophic DNS failure
Mantas's avatar
Mantas committed
56
Description: After moving from one server to another, DNS just kinda gave us the middle finger. Ugh.
57
58
59
60
61
62
63
64
65
Date: 2017-04-04T15:58:32
Section: post
---

##### Post-mortem

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

Mantas's avatar
Mantas committed
66
## Contribute
67

Mantas's avatar
Mantas committed
68
Feel free to open an issue or make a pull request, those should get answered pretty quickly on GitHub.
69
70
71
72

## License

MIT © Mantas Vilčinskas