README.md 10.2 KB
Newer Older
Mantas's avatar
Mantas committed
1
<p align="center"><img src="https://raw.githubusercontent.com/cstate/cstate/master/images/highlight.svg?sanitize=true" alt="cState example illustration"></p>
Mantas's avatar
v2-dev2    
Mantas committed
2

Casper's avatar
Casper committed
3
<p align="center"><a href="https://github.com/cstate/cstate/releases"><img src="https://img.shields.io/github/release/cstate/cstate/all.svg?style=flat-square" alt="GitHub release" /></a> <a href="https://github.com/cstate/cstate/commits/master"><img src="https://img.shields.io/github/last-commit/cstate/cstate.svg?style=flat-square" alt="GitHub last commit" /></a> <a href="https://github.com/cstate/cstate/tree/master/"><img src="https://img.shields.io/github/repo-size/cstate/cstate.svg?style=flat-square" alt="GitHub repo size in bytes" /></a> <a href="https://discord.gg/zYCjzys"><img src="https://img.shields.io/badge/discord-support-7289DA.svg?logo=discord&style=flat-square" alt="Discord Chat" /></a> <a href="https://twitter.com/cstate"><img src="https://img.shields.io/twitter/follow/mistermantas.svg?style=social&amp;label=Follow" alt="Twitter" /></a> <a href="https://github.com/ivbeg/awesome-status-pages"><img src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" alt="Awesome status page" /></a></p>
Mantas's avatar
v2-dev2    
Mantas committed
4

5
> Über fast, backwards compatible (IE8+), tiny, and simple status page built with Hugo. Completely _free_ with Netlify, Netlify CMS.
6

7
[**🎯 Want an example? Click here to see a live demo!**](https://cstate-example.netlify.com)
Mantas's avatar
Mantas committed
8

9
[👩‍💻 You can also see what an example cState project’s source code.](https://github.com/cstate/example)
Mantas's avatar
v2-rc1    
Mantas committed
10

Mantas Vilčinskas's avatar
Mantas Vilčinskas committed
11
12
13
14
15
16
17
18
19
20
21
## Who uses cState? 🥳

Some more examples from the internet:

* [Chocolatey](https://status.chocolatey.org/)
* [Proventa](https://status.proventa.io/) (German)
* [sr.ht](https://status.sr.ht/)
* [Content Ignite](https://status.contentignite.com/)

*Want your status page here? [Create a Pull Request](https://github.com/cstate/cstate/edit/dev/README.md)!*

22
## Contents ⁉
23

24
25
+ [Features](#features-)
+ [Getting started](#getting-started-)
Mantas's avatar
Mantas committed
26
27
  + [Production](#production)
  + [Development](#development)
28
29
30
+ [Updating](#updating-)
+ [FAQ](#faq-)
+ [Contribute](#contribute-)
31
* [Support](#support-)
32
+ [License](#license-)
33

Mantas's avatar
Mantas committed
34
35
***

36
37
38
## Features 😎

**Designed with care**
Mantas's avatar
Mantas committed
39

40
* **New in v4**: automatically ships with dark mode
41
+ Comes with a simple, focused, and extremely light design
42
+ Works not just on mobile, but also on the archaic Internet Explorer 8 for some reason
43
44
+ Makes you accountable, showcasing how long it took for an issue to be resolved
+ Great for data manipulation and viewing — has RSS, tag-like system feeds
45
+ Customizable views, colors, HTML, and other elements
46

47
**Fast, reliable, and free (even to host)**
48
49

+ Built with [Hugo](https://gohugo.io), a hyperfast Golang generator
50
+ Secure, ready for HTTPS; see [JAMstack](https://jamstack.org/)
51
52
53
54
+ Easy to edit and deploy on Netlify for _absolutely free_

**Easy to setup, manage, use**

Mantas's avatar
Mantas committed
55
56
+ Edit your status page from a simple config file
+ Comes pre-equipped with Netlify CMS for quick admin updates
Mantas's avatar
v2-rc1    
Mantas committed
57
+ Extensive documentation on the [wiki](https://github.com/cstate/cstate/wiki)
58
59
+ You can not only create issues, but also informational, about pages
+ **New in v4**: [Read-only API available](https://github.com/cstate/cstate/wiki/API)
Mantas's avatar
Mantas committed
60

61
## Getting started 💻
Mantas's avatar
Mantas committed
62
63

For this tutorial, it is assumed that you have Hugo and Git installed (check with `hugo version` & `git --version`).
Mantas's avatar
Mantas committed
64

65
66
> A minimum version of `0.48` is required for Hugo, starting with v3.

Mantas's avatar
Mantas committed
67
#### Production
Mantas's avatar
Mantas committed
68

69
70
71
72
We encourage you to use [Netlify](https://www.netlify.com) for cState. These are the following options you need to change in deploy settings:

+ Build command: **hugo**
+ Publish directory: **public**
Mantas's avatar
Mantas committed
73
+ Add one build environment variable
74
  + Key: **HUGO_VERSION**
75
  + Value: **0.48** (or later)
Mantas's avatar
Mantas committed
76

Mantas's avatar
Mantas committed
77
78
79
80
81
82
83
84
**The easy way**

You can simply click this button to get started:

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/cstate/example)

This sets up cState with its default settings from the cstate/example repo.

Mantas's avatar
Mantas committed
85
***
Mantas's avatar
Mantas committed
86

Mantas's avatar
Mantas committed
87
88
If you want to do this from any branch in this repository, follow the manual instructions:

Mantas's avatar
Mantas committed
89
90
1. Download the contents of the `exampleSite` directory in this repository. This will be your site guts, which will hold the content and configuration for the status page.
2. Create a `themes` folder and navigate to it on the command line.
Mantas's avatar
Mantas committed
91

92
```bash
Mantas's avatar
Mantas committed
93
94
mkdir themes; cd themes;
```
Klaus's avatar
Klaus committed
95
96
97
98
99
2. Start Git on this folder: 

```bash
git init
```
Mantas's avatar
Mantas committed
100

Mantas's avatar
Mantas committed
101
3. Now simply add a Git submodule pointing to this repository, like so:
102

Mantas's avatar
Mantas committed
103
```bash
Mantas's avatar
v2-rc1    
Mantas committed
104
git submodule add https://github.com/cstate/cstate
105
```
106

Mantas's avatar
Mantas committed
107
4. Set up cState for your liking. It is now ready to be used in production.
Mantas's avatar
Mantas committed
108
109

#### Development
110

Mantas's avatar
Mantas committed
111
1. Clone this repository in the command line:
112

Mantas's avatar
Mantas committed
113
```bash
114
git clone --recursive -b master https://github.com/cstate/cstate.git
Mantas's avatar
Mantas committed
115
```
116

Mantas's avatar
Mantas committed
117
2. Navigate to the theme directory:
118
119

```bash
120
cd cstate/exampleSite
Mantas's avatar
Mantas committed
121
```
122

Mantas's avatar
Mantas committed
123
3. Launch the development setup much like this:
124

Mantas's avatar
Mantas committed
125
```bash
126
hugo serve --baseUrl=http://localhost/ --theme=cstate --themesDir=../.. --verbose
127
128
```

Mantas's avatar
Mantas committed
129
130
131
The main directory is the theme itself (the cState guts, basically) and the `exampleSite` folder houses all content. Use this local setup to experiment before deploying to production!

If you would like to commit/make a PR, make sure that `themesDir` is a comment before trying to merge upstream.
132

133
## Updating 🎉
134

135
**If you are updating from one major version to another, like from v3 to v4, then please [read the migration guides](https://github.com/cstate/cstate/wiki/Usage#migration-guides).**
136

137
Assuming the production install instructions were followed, keep cState updated by having an up to date Git submodule in the `themes` folder. containing this repository. Your content will stay separate.
Mantas's avatar
Mantas committed
138

139
Ask yourself these questions:
140

141
142
143
144
145
1. Do I already have the **up to date** Git repository with my status page on my computer?
  * If not, go to your desktop or somewhere else, where you can download your Git repository and run: `git clone --recursive <your repo link goes here> && git submodule foreach git pull origin master`.
  * In the parent directory, type `hugo serve`. Check to see if everything is working.
  * Then do `git add -A; git commit -m "Update cState"; git push origin master; exit`. Your status page is now updated.
2. If you **DO** have the directory, go inside `themes/cstate`. If that is empty, it is easier to delete your local copy and do the steps outlined earlier.
Mantas's avatar
Mantas committed
146

147
There is currently no easier way to do this, unfortunately, you will need the terminal / command line / Git Bash, unless you want to create a new status page from scratch and move your data over manually.
Mantas's avatar
Mantas committed
148

149
More info about submodules: [updating](https://stackoverflow.com/a/5828396) & [cloning](https://stackoverflow.com/questions/3796927/how-to-git-clone-including-submodules).
Mantas's avatar
Mantas committed
150

151
## FAQ 🤔
Mantas's avatar
Mantas committed
152

153
154
155
156
### Are there settings you can change?

Yes, most of the settings are in the `config.yml` file or under _Settings_ in Netlify CMS.

Mantas's avatar
Mantas committed
157
158
159
160
161
162
163
### Where do issues go?

#### Using an admin panel (Netlify CMS)

This takes a little more effort to set up but pays off in the long run — [see the wiki](https://github.com/cstate/cstate/wiki) for up to date information.

#### Doing it from the Git repository
164

165
Create a file in `content/issues`. The name of the file will be the slug (what shows up in the URL bar). For example, this is what `2017-02-30-major-outage-east-us.md` should look like:
166
167
168

```md
---
Mantas's avatar
Mantas committed
169
170
title: Major outage in East US
date: 2017-02-30 14:30:00
SUNNY's avatar
SUNNY committed
171
resolved: true
Mantas's avatar
Mantas committed
172
173
174
resolvedWhen: 2017-02-30 16:00:00
severity: down
affected:
Mantas's avatar
Mantas committed
175
  - API
Mantas's avatar
Mantas committed
176
section: issue
177
178
---

Mantas's avatar
Mantas committed
179
*Monitoring* - After hitting the ole reboot button Example Chat App is now recovering. We’re going to continue to monitor as everyone reconnects. {{< track "2018-04-13 16:50:00" >}}
Mantas's avatar
Mantas committed
180

Mantas's avatar
Mantas committed
181
*Investigating* - We’re aware of users experiencing unavailable guilds and issues when attempting to connect. We're currently investigating. {{< track "2018-04-13 15:54:00" >}}
182
183
```

184
185
Time to break that down.

Mantas's avatar
Mantas committed
186
187
188
189
190
191
192
`title`: This is the one of the most important parts of an incident. *(required)*  
`date`: An ISO-8601 formatted date. Does not include time zone. This is when you first discovered the issue. *(required)*  
`resolved`: Whether issue should affect overall status. Either `true` or `false`. *(boolean, required)*  
`resolvedWhen`: An ISO-8601 formatted date. Does not include time zone. This is when downtime stopped. You may set the time that downtime ended without completely resolving the issue (thus leaving time for monitoring).  
`severity`: If an issue is not resolved, it will have an applied severity. There are 3 levels of severity: `notice`, `disrupted`, and `down`. If there are multiple issues, the status page will take the appearance of the more drastic issue (such as `disrupted` instead of `notice`). *(required)*  
`affected`. Add the items that were present in the config file which should alter the status of each individual system (component). *(array, required)*  
`section`. This must be `issue`, so that Hugo treats it as one. *(required)*  
193

Mantas's avatar
v2-rc1    
Mantas committed
194
195
196
197
### I have more questions!

Check out [the wiki](https://github.com/cstate/cstate/wiki).

198
199
200
201
202
203
204
## Support ❤️

cState is only a hobby project of @mistermantas, but it has turned into something a little bit bigger.

Please **star, share, and use the software**. Thank you, if you do.

If you wish to support the project financially:
Mantas's avatar
Mantas committed
205

206
[Sponsor the author @mistermantas on GitHub](https://github.com/sponsors/mistermantas)
Mantas's avatar
Mantas committed
207

208
[Support the author on PayPal](https://www.paypal.me/mistermantas)
Mantas's avatar
Mantas committed
209
210


211
## Contribute 💥
212

213
> Want to become a maintainer? Hit me up [on Twitter @mistermantas](https://twitter.com/mistermantas)
Mantas's avatar
Mantas committed
214

215
+ Glance over the [Code of Conduct](/CODE_OF_CONDUCT.md).
Mantas's avatar
v2-rc1    
Mantas committed
216
+ Before submitting a pull request, create an issue to [discuss the implications of your proposal](https://github.com/cstate/cstate/issues).
217
+ Or if you are a translator — [see this](https://github.com/cstate/cstate/wiki/Translations#add-your-translations).
218
219
+ Write consistent, simple, readable code, and precise documentation.
+ Version numbers should be added in the JS partial, the meta[generator] tag, and API index!
220
221

## License ✍
222

223
[MIT](https://github.com/cstate/cstate/blob/master/LICENSE.md) © [Mantas Vilčinskas](https://github.com/mistermantas)
224

225
Thanks to all the [contributors](https://github.com/cstate/cstate/graphs/contributors)!