Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 1.74 KB

README.md

File metadata and controls

51 lines (34 loc) · 1.74 KB

Simple Landing Page Placeholder

CI  GitHub Release  GitHub License

A simple landing page placeholder with built-in email protection.

screenshot

Usage

The title, contact email address, and color palette are settable with defaults. All three are strings but the PALETTE must be a valid colorbrewer palette (i.e. 'YlGnBu' or 'RdBu').

To set them, set an environment variable before running the build.

[email protected] PALETTE=Blues TITLE="My Site" npm run build
Name Description Default
EMAIL Email address used as the contact email address [email protected]
TITLE Title displayed with the contact email example.com
PALETTE Colorbrewer pallete to use as the color scheme random

Build

Build the application for deployment.

npm run build

The deployable build artifacts will be written to a dist directory in the repo root.

Development

Run the local webpack-dev-server with livereload and autocompile on http://localhost:8080.

npm run dev

Credits

This is a fork of the original landing page template repo made by @cvgellhorn. I liked it so much I updated its dependencies to current and made a few changes so the color palette and title are settable.