A simple wedding website that is:
- Fast to load.
- Customizable.
- Low dependency.
- No JS.
- Free & ad-free to host.
Because other wedding websites out there miss at least one of the above.
👉 Demo Website 👈
This project uses git and NodeJS, so please install those first. I've tried Node v12.16, but others may work too.
Then clone and install the dependencies:
git clone https://github.com/beekley/wedding-template.git
npm install
The following command will build a sample version of the website:
npm run build-sample
To customize, create a config.real.js [1] at the root directory of the project, edit it, and build:
cp config.js config.real.js
npm run build
See the comments in config.js for API documentation.
[1] Note that this file is not checked in because it may contain sensitive data about your wedding.
This website is not modularly configurable. If you wish to make changes to the layout, edit the pug templates defined in templates/.
An easy way to publish the website is to use Github Pages. Please refer to their documentation for more information.
I host my website using GCP since it is free (at my use levels) while Github Pages requires a subscription for private repos. To do this, follow these steps in GCP's documentation. To upload local files, run:
BUCKET_NAME={your bucket name} npm run upload
I'm sure there is a similar solution using AWS/Azure/etc.
- 1.0.0
- CHANGE: Initial release
Please use and modify as you wish (according to the license). I'd love to see what y'all make with it-- if you're up for it, email me a link to your finished website.