/flux-website-v2

Voteflux.org website. Version 2

Primary LanguageHTMLMIT LicenseMIT

Instructions

Dependencies

Docker

If you have docker installed just run ./dev-docker.sh - that should get you developing straight away (well, minus the minutes required to build and install deps)

Manually

We presume your environment is OSX.

  • Install node, npm, ruby, yarn first
  • macOS: brew install ruby node npm yarn
  • ubuntu: sudo apt install ruby nodejs (aside: does this include npm?)
  • Ubuntu: Note: you'll need to install yarn yourself
  • Fedora: redhat-rpm-config
  • Install dependencies: ./dev-install-deps.sh or if that doesn't work: gem install bundle then bundle install then yarn install

Note: Node v11 doesn't seem to work building for some deps

Development

  • To run a development copy for everything run ./dev-watch-all.sh or yarn flux
  • To simulate a build run yarn build

Deployment

  • Deployments automatically happen via the master branch.
  • All merges require a PR.

Hints and Tips

brew install ruby for ruby

gem install bundle for bundle

bundle install to install dependencies

bundle exec jekyll serve --watch to run a dev server for just jekyll stuff.

React is used for the signup form but not for anything else.

Kip's notes on contributing

MK note: if you need to use sudo to run ./dev-docker.sh you should add yourself to the docker group (or google what to do for your OS); typically you shouldn't need sudo for docker, or at least it's good not to run it like that on your dev machine.