Onehot

Website for our data science meetup.

Onehot uses the following domains:

• onehot.nl (canonical)
• onehot.eu
• onehot.org
• 1hot.nl
• 1hot.eu

Development

There are two options here:

• Install nix and direnv and use our managed development environment.
• Use a more traditional development environment based on Python's virtualenvs and installing dependencies manually. You probably want this if you are on MacOS.

Nix setup

There are two steps:

1. Install nix
2. Install direnv

Then:

$ git clone git@github.com:duijf/onehot.git
$ cd onehot
$ ln -s .envrc.nix .envrc
$ direnv allow

MacOS

# Install homebrew if you don't have it already (you have it already if
# `brew` returns help output instead of "command not found").
# Follow the instructions that this command prints to set up your shell.
$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Now install the following dependencies that your are going to need:
# Inspect the output of this command to set up direnv and pyenv in your
# shell config.
$ brew install overmind direnv watchexec pyenv coreutils

# Now you are ready to set up the project itself.
$ git clone git@github.com:duijf/onehot.git
$ cd onehot

# Install an appropriate python version for the project.
$ pyenv install

# Create a Python virtualenv.
$ python -m venv .env

# Activate the direnv script to source the virtualenv.
$ ln -s .envrc.osx .envrc
$ direnv allow

# At this point, your virtualenv should be loaded. Confirm by
# checking what Python you are using. This should output a path
# in the onehot directory.
$ which python
/Users/<yourname>/<some>/<path>/<to>/onehot/.env/bin/python

# Install development dependencies and you're all set!
$ pip install -r requirements.txt

Commands

# Run direnv allow to automatically load a development shell
# when `cd`ing to the current directory.
$ direnv allow

# Development server + build the website in the background.
# Available on http://localhost:8000
$ start

# Build the website.
$ cli build

# Deploy the website to GitHub pages.
$ cli deploy

# Run pre-commit lints and checks
$ pre-commit

# Install pre-commit lints and checks to run for every commit.
$ pre-commit --install

# List other available commands. These shell scripts have been
# added to your PATH by direnv, so you can call them directly
# (that's how `start` and `pre-commit` work).
$ ls bin/
build pre-commit serve start

Architecture

This is what's in the repo:

• web/ contains templates, static pages, and stylesheets for our website. All HTML files are Jinja2 templates.
• events.yaml contains our data model (currently only events).
• bin/build is a build script that combines the templates and data and outputs a static site at ignore/dist.
• In local development, we serve ignore/dist using Python's built in HTTP server. We also rebuild on file changes. Overmind coordinates the processes.
• In production, the site is built using Nix and served using Nginx. (Laurens's personal Nix config imports release.nix and adds it to his Nginx setup).
• There are some miscelaneous scripts that are used for linting etc.
• Nix is used for the development environment. I'll be happy to explain more about this, but there is a lot to discuss so let's do that when there is a need.

How to contribute

There is this basic loop:

• Make changes you want.
• Build the website. (cli build)
• Deploy the changes. (cli deploy)

You can use the start command to preview the changes locally before deploying them.

License

The code in this repository is licensed under version 2.0 of the the Mozilla Public License. The textual and image content in this repository is copyright the original authors and is not available under this license.

Please see the LICENSE file for details.