https://github.com/fwd/status
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fwd/status
- Owner: fwd
- Created: 2022-08-15T01:47:53.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-08-15T01:54:40.000Z (over 2 years ago)
- Last Synced: 2025-01-07T10:11:22.122Z (4 months ago)
- Language: HTML
- Size: 199 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
Easy Status Page
Hosted on Github
## ❯ 1. Clone
```bash
git clone [email protected]:fwd/status.git && cd status
```
## ❯ 2. Configure
Open ```config.json``` in any editor, and serve ```/index.html``` with a server.
- **NPM**: ```npm start```
- **PHP**: ```php -S localhost:8080```
**Editable:**
- [config.json](/config.json) - Configure Servers.
- [favicon.png](/favicon.png) - Customize Favicon.
**Optional:**
- [index.html](/index.html) - Most things are configured via JSON file.
- [/dist](/dist) - Status CSS & JS Files.
## ❯ 3. Deploy
Remove the .git folder, and add your own.
```bash
rm -rf .git
git init
git add . && git commit -m "Look Ma! I'm on Github."
git branch -M "master"
git remote add origin [email protected]:NAME/REPO.git
git push -u origin "master"
```
## ❯ 4. Free Website Hosting
- Github repo must be public
- Go to [Settings Page](/../../settings/pages)
- Source → "Master" → "/Root"
- Save
Your public URL: https://NAME.github.io/REPO
#### Optional: Custom Domain:
- Go to [Settings Page](/../../settings/pages)
- "Custom domain" → "Add Domain"
- Save
##### Domain DNS Settings
- Create **A** record that points to: **185.199.108.153**
- If using Cloudflare, make sure to disable proxy.
Official Docs: https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site
## ❯ ✅ Done
You now have free, reliable hosting for your docs. Nice.
#### Update Template
```
npm run update
```
## ❯ Contributing
Give a ⭐️ if this project helped you!
Contributions, issues and feature requests are welcome at [issues page](https://github.com/fwd/status/issues).
## ❯ License
MIT License
Copyright © [@nano2dev](https://twitter.com/nano2dev).
## ❯ Stargazers
[](https://github.com/fwd/status)