Skip to content

Latest commit

 

History

History
94 lines (67 loc) · 4.28 KB

README.md

File metadata and controls

94 lines (67 loc) · 4.28 KB
Raw

Chi Hack Night website

Website for Chi Hack Night.

Chi Hack Night is Chicago's weekly event to build, share & learn about civic tech.

Hosted by Netlify.

Dependencies

  • Jekyll - Static site generator built in Ruby
  • Bootstrap 3 - HTML and CSS layouts
  • DataTables - for searching and sorting tables
  • Mustache - templating library for javascript (used on projects page)
  • jQuery Address - for deep linking URLs on the projects page

Running locally

Requirements:

  • ruby-2.6.2
  • jekyll 3.6.3

We recommend using rvm to manage your Ruby versions.

Initial setup

git clone https://github.com/chihacknight/chihacknight.org.git
cd chihacknight.org
rvm install ruby-2.6.2
bundle install

Running locally

jekyll serve -w

Then open your web browser and navigate to http://localhost:4000

Run in a Docker container

If you have Docker installed, can avoid some of the hassle of installing Jekyll and/or Ruby by pulling from the offical Jekyll image, installing dependancies, and serving locally.

This is especially handy if you're on Windows machine:

docker run --rm --label=jekyll --volume=%CD%:/srv/jekyll  -it -p 4000:4000 jekyll/jekyll set JEKYLL_VERSION=3.6.3 | bundle install | jekyll serve

Deploying

Deployments are handled by Netlify by pushing to the production branch.

Whenver a branch is merged into production, or a commit is pushed to production it will trigger a Netlify deploy.

Workflow

The Chi Hack Night web team manages bugs, new features and site development through the GitHub project board.

To ensure high code quality, we practice using pull requests and having at least one member of the web team review them before merging in to production.

Protocols

Cancelled presenters If a presenter cancel after we have sent out our email blast, we add CANCELLED PRESENTATION to the event title and update the description of the event noting that it will be an open hack event. Example: https://chihacknight.org/events/2018/10/09/censusbureau.html

Tagging Events are tagged with one or more categories to help organize and find similar presentations and events. The most common tags we use are:

  • openhack: events with no presentation, but breakout groups meet
  • govtech: government and technology
  • education: anything relating to schools, education or learning
  • journalism: presentations from journalists on their reporting
  • equity: racial and gender equity
  • criminal justice: relating to courts, crime, and police forces
  • satellite: events held outside our typical downtown meeting spaces
  • environment: climate change, conservation, nature
  • elections: covering and educating municipal, state, and national elections
  • advocacy: organizations or individuals that advocate for policy positions
  • nonprofit: non-for-profit organizations and foundations
  • housing: real-estate, affordable housing and policy around it
  • open data: release of free, interoperable and structured government data
  • breakout: presentations from our own breakout groups
  • mapping: creating or using maps to explore data
  • design: talks focusing on the design process or methods
  • community: community feedback sessions
  • transportation: trains, buses, roads and the use of transportation infrastructure
  • data analytics: analyzing large amounts of data to determine trends and findings
  • politics: lobbying, issue advocacy, political campaigns, local government dynamics, 'how the sausage is made', etc
  • health: hospitals, public health and policy

Projects and People

The projects and people pages are powered by Github and civic-json-worker, a script we run every 5 minutes that fetches data from the Github API.

The JSON files are backed up every hour in the civic-json-files repository.