Adds development instructions

HACKING.md

@@ -0,0 +1,27 @@
+# HACKING
+
+## Requirements
+
+To work on the codebase, you need a supported version of the following:
+
+1. Bundler + Ruby
+2. NPM + Node.js
+
+## Setup
+
+```bash
+git clone https://github.com/blr-today/website.git blr-today-website
+cd blr-today-website
+# Install Jekyll and dependencies
+bundle install
+# Install node.js dependencies
+npm install
+# Fetches the latest blr.today dataset
+npm run fetch-calendar
+# Build the JS bundle
+npm run build
+# Build the Jekyll site and run the dev server
+bundle exec jekyll serve -w
+```
+
+Open <http://localhost:4000> in your browser. Since the CSS is hot-linked, you will need working internet for the site to work.

README.md

@@ -1,5 +1,13 @@
 # blr.today [![Netlify Status](https://api.netlify.com/api/v1/badges/22e12fee-effc-43e9-a409-2c0d2e8d7602/deploy-status)](https://app.netlify.com/sites/blr-today/deploys)
 
+The site is published at <https://blr.today>
+
+## Setup
+
+Please see <HACKING.md>.
+
+## LICENSE
+
 * The codebase for the website is available at https://github.com/blr-today/website
 * The website code is under the AGPL-3.0-or-later license.
 

TODO.md

@@ -1,39 +1,46 @@
 ---
 layout: default
 permalink: /roadmap/
+title: TODO
 ---
 # TODO
 
-- [ ] Set default view for each tag
-- [x] Add combination tag support
+## Launch Priority
+
+- [ ] Supported list of views for each calendar
 - [ ] Make subscribe into a button
 - [ ] Show popup on clicking subscribe
 - [ ] Show QR code in subscribe popup
-- [ ] Show curated events in home page
-- [x] Setup build pipeline
 - [ ] Include PVR data
-- [x] Fetch events.db
-- [ ] Check include/exclude
 - [ ] Popup display event details.
 - [ ] Hide unused hours for each calendar.
+- [ ] Test the behaviour with identical events in multiple calendars, with same UID
+	See if we can get away with some really cool ideas. (Update: Does not look like this plan will work)
+- [ ] Add full map support.
+- [ ] Create a neighbourhoods page.
+- [ ] Ingest PVR
+- [ ] Show tags in calendar view https://github.com/blr-today/website/issues/19
+- [x] Check include/exclude
 - [x] Add Footer
 - [x] Add about page
+- [x] Show curated events in home page
 - [x] Convert tag pages into markdown pages
       so we can provide some commentary on each page
       giving links to upstream socials, and subscribe
       features. We can put the query details
       within the page front-matter!
 - [x] Add favicon
-- [ ] Test the behaviour with identical events in multiple calendars, with same UID
-	See if we can get away with some really cool ideas.
 - [x] Fork fullcalendar/icalendar so we can add support for event colors.
-- [ ] Add full map support.
 - [x] Set a visible range based on the calendar to only show relevant dates.
       https://fullcalendar.io/docs/visibleRange
 - [x] Hide past events
+- [x] Setup build pipeline
+- [x] Add combination tag support
+- [x] Fetch events.db
 
 # Ingestion
-
-- [x] Tag UC events, and other cool hosts
+- [ ] Fancy tagging https://github.com/blr-today/ingest/issues/49
+- [ ] Event combinations https://github.com/blr-today/ingest/issues/48
 - [ ] Nominatim (+cache) to add GeoCoordinates to every Place
-- [ ] Create tags for Event.@type 
+- [ ] Create tags for Event.@type
+- [x] Tag UC events, and other cool hosts