Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cable8mm/maintenance

Simple Maintenance Page
https://github.com/cable8mm/maintenance

html-css landing-page maintenance static vanilla

Last synced: about 2 months ago
JSON representation

Simple Maintenance Page

Awesome Lists containing this project

README

        

# Maintenance

[![update changelog](https://github.com/cable8mm/maintenance/actions/workflows/update-changelog.yml/badge.svg)](https://github.com/cable8mm/maintenance/actions/workflows/update-changelog.yml)
![Static Badge](https://img.shields.io/badge/Vite-5.1.4-646CFF?logo=vite&labelColor=FED32B)
![Static Badge](https://img.shields.io/badge/HTML-CSS-red?logo=html5&label=HTML)
![GitHub Release](https://img.shields.io/github/v/release/cable8mm/maintenance)
![GitHub License](https://img.shields.io/github/license/cable8mm/maintenance)

The 'HTML Simple Maintenance Page' is a lightweight maintenance page designed in a simple HTML format, requiring only one file.

![Preview](/docs/assets/maintenance-preview.png)

## Install

```sh
git clone https://github.com/cable8mm/maintenance.git
```

## Usage

Edit `public/index.html` and upload files in `public` folder.

## Development

Install npm packages:

```sh
npm install
```

And you can create and edit website with hotload.

```sh
npm run dev
```

At last, visit http://localhost:5174/. The port 5174 can be changed as needed. You are free to edit `index.html` and the `maintenance.png` image.

## Test

The website reloads whenever you save `index.html`. Trust your eyes and instincts.

## Deploy

Copy the files located in the `public` folder to the document root in your web server.

While FTP is good, using rsync would upload faster. Additionally, CI/CD is generally the best approach.

## License

The Maintenance is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).