Skip to content

Latest commit

 

History

History
94 lines (59 loc) · 3.03 KB

README.md

File metadata and controls

94 lines (59 loc) · 3.03 KB

The Trans Dimension

A PlaceCal community site

Front-end for The Trans Dimension, an online community hub which will connect trans communities across the UK by collating news, events and services by and for trans people in one easy-to-reach place. A collaboration between Gendered Intelligence and Geeks for Social Change.

Funded by the Comic Relief Tech for Good “Build” fund. Read more about the project here.

Development

Prerequisites

Setup & install instructions

  • make sure you are using the correct node version with nvm use
  • install with npm installi

Build

  • npm start to start a dev server on http://localhost:3000
  • npm build generate a production build in dist/

Formatting

We recommend integrating elm-format@0.8.3 into your code editor, but if you don't...

  • Please run npm format to format .elm files in src before committing code.

Testing

We're using elm-test-rs(https://github.com/mpizenberg/elm-test-rs) to run elm tests

  • run tests with npm test

Code & configs

This site is built with elm-pages

What it's for

  • elm.json for elm packages used for site
  • elm-tooling.json for elm packages used for code
  • package.json for node scripts and packages
  • package-lock.json for current versions of node packages
  • .nvmrc contains project node version
  • .netlify.toml for deploy config
  • tests/* contains test files
  • public/* contains static files to be copied direct to build
  • src/* contains app source files

Content & Pages

  • TBC

Styling & layouts

  • TBC

Deployment

Deploys to Netlify

  • code is tested and linted automatically before deploy
  • when a pull request is created, a preview site is deployed
  • when a pull request is merged into main, the prodtion site is deployed

Development workflow

Adding issues

  • add effort & value labels (if you know enough about it)
  • put the issue in a milestone (if it is part of a current epic)

Working on issue

  • assign it to yourself before starting work
  • make a branch that includes the issue type (fix/feat/chore etc & number)
  • make sure you understand the acceptance criteria
  • ask questions & make plan

Code review & merge

  • check the acceptance criteria have been met
  • add comments & questions
  • once approved, leave for the author to squash and merge