Skip to content

wearelighthouse/ManyHands-site

Repository files navigation

ManyHands-site

Local development

Editing can be done in-browser at github.dev/wearelighthouse/ManyHands-site, however running the site and viewing changes pre-deployment requires local development.

Prerequisites

  • Git
  • Node.js & NPM (preferably via a Node version manager)
  • Write access to this repository, or a fork of it within your own GitHub profile, that we can accept PRs from.

Setup

  1. Clone the repository
    git clone git@github.com:wearelighthouse/ManyHands-site.git

  2. Change directory
    cd ManyHands-site

  3. Install dependencies
    npm install

  4. Fetch fonts (optional - password in LH 1Pass)
    npm run font:fetch

  5. Run hot-reloading dev server (this will open up a web browser at localhost:3000)
    npm run watch

Making changes

  1. Checkout a new feature/ content/ or fix/ branch, e.g.
    git checkout -b content/event-april-28-2022

  2. Start up the local dev environment (if it's not running already)
    npm run watch

  3. Make your changes via any text editor (VS Code or Atom recommended)

  4. Commit changes
    git commit -am "Replace old event with info & link to 28/04/2022 event"

  5. Push changes to this repo
    git push --set-up orgin content/event-april-28-2022

  6. Create a new Pull Request on GitHub for your branch

Deployment

Changes to the branch main (e.g. accepted Pull Requests) are automatically deployed to wearelighthouse.github.io/ManyHands-site/