https://github.com/maxboeck/emergency-site

A template for emergency information websites
https://github.com/maxboeck/emergency-site

Last synced: 3 days ago
JSON representation

A template for emergency information websites

• Host: GitHub
• URL: https://github.com/maxboeck/emergency-site
• Owner: maxboeck
• License: mit
• Created: 2020-03-20T12:13:43.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-03-04T07:11:58.000Z (over 1 year ago)
• Last Synced: 2024-07-31T19:30:00.409Z (3 months ago)
• Language: JavaScript
• Homepage: https://emergency-site.netlify.app
• Size: 1.3 MB
• Stars: 796
• Watchers: 11
• Forks: 54
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Emergency Site Kit

A starter kit for emergency information websites. (WIP) ([Demo Site](https://emergency-site.netlify.app/))

In case of emergency, many organizations need a quick way to publish critical information. Existing CMS websites are often unable to handle sudden spikes in traffic, and local network infrastructure might be damaged, leaving those affected with poor mobile connections.

This project aims to enable people to quickly publish a simple website that can withstand large amounts of traffic and will work even under extreme conditions. It is built on the [rule of least power](https://en.wikipedia.org/wiki/Rule_of_least_power), using simple technologies for maximum resilience.

For more information about this project, watch [the talk at Inclusive Design 24](https://noti.st/mxb/a1xCB1).

## Features

* Static files generated by [Eleventy](https://11ty.dev)

* Optimized for first connection roundtrip (> 14KB)

* Basic styling for accessibility

* One critical request, inlined CSS

* [Netlify CMS](https://www.netlifycms.org/) for content editing

* Offline support with service worker

## Getting Started

To publish a website with this template, there are two options, depending on your technical skillset. Choose which one describes you best:

* [I'm not a developer](https://github.com/maxboeck/emergency-site/blob/master/src/posts/2020-03-20-getting-started.md#no-code-setup), I just want to set up a website

* [I have basic knowledge](https://github.com/maxboeck/emergency-site/blob/master/src/posts/2020-03-20-getting-started.md#advanced-setup) of how to use `npm` and the command line 

Read the [Getting Started Docs](https://github.com/maxboeck/emergency-site/blob/master/src/posts/2020-03-20-getting-started.md)

## Configuration

It's possible to customize some parts of the website through environment variables. You can set these up on your local machine in an `.env` file or define them through the Netlify admin interface.

The available settings are:

    

        NameDescriptionExampleDefault

    

    

        

            META_TITLE

            the title of your site

            COVID-19 Information

            Emergency Site

        

        

            META_URL

            the full url of your site

            https://www.covid19.org

            N/A

        

        

            META_DESC

            a short description of your site

            Updates on the current state of the pandemic.

            An emergency information website.

        

        

            META_LANG

            the 2-letter language code of your site

            de

            en

        

        

            META_COLOR

            the primary color hex code (optional)

            #1D70B8

            #DB0000

        

        

            META_EMAIL

            your main contact email (optional)

            [email protected]

            N/A

         

        

            META_TELEPHONE

            your main contact phone number (optional)

            +01 23 456 789 00

            N/A

         

       

## One-Click Deployment

The easiest way to go live is by forking this repo and deploying it to Netlify.  

You can do that by clicking this button:  

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

## Local Development

To run this locally, you need to install [Node](https://nodejs.org/en/) first.  

You can run these on the command line in the root of your project:

* `npm start`: starts development server

* `npm run build`: generates a production build

* `npm run debug`: runs eleventy with debug output

To customize the site, edit `src/data/meta.js` with your details, or set the corresponding environment variables. Replace the markdown files in `src/posts` with your content.