From cf515b1d6a068981b520f2895e2ab89e97cb7cbd Mon Sep 17 00:00:00 2001 From: Peter Molnar Date: Thu, 6 Jun 2019 10:27:57 +0100 Subject: [PATCH] readme --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..25c6745 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Pa-Kua UK + +This is a tiny website built for Pa-Kua School UK. Most of the content is in standard HTML format glued together with some vanilla PHP. It's all extremely simple and small. + +## External services + +- videos are embedded from Youtube +- maps are embedded from Google Maps +- newsletter form is for Mailchimp +- gallery is auto generated from Flickr and hot links to Flickr hosted images + +## Data + +Org and site data are in JSON-LD files in `site.json` and `org.json`. Each page has a `.html` part and a `.json` part; the JSON is JSON-LD and for metadata, while the HTML will populate the `
` part of the page. + +## Example `flickr.json` + +The required `flickr.json` file is not in the repository, because it contains and API key. It shoudl look like this: + +```json +{ + "api_key": "KEY", + "photoset_id": "ID", + "user_id": "UID" +} +```