Skip to content

Commit

Permalink
Add dev info to readme (#29)
Browse files Browse the repository at this point in the history
* Add dev info to readme

* Tweak headings in readme
  • Loading branch information
katjam authored Feb 10, 2022
1 parent abb2367 commit 0c49121
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,58 @@ Funded by the [Comic Relief Tech for Good “Build” fund](https://techforgoodh

## Prerequisites

- [node](https://nodejs.org/)
- [nvm for macOS & Linux](https://github.com/nvm-sh/nvm) or [nvm for Windows](https://github.com/coreybutler/nvm-windows)

## Setup & install instructions

- make sure you are using the correct node version with `nvm use`
- install with `npm install`i

## 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](https://github.com/elm-explorations/test/)

- run tests with `npm test`

## Code & configs

### This site is built with `elm-pages`

- [Documentation site](https://elm-pages.com)
- [Elm Package docs](https://package.elm-lang.org/packages/dillonkearns/elm-pages/latest/)
- [`elm-pages` blog](https://elm-pages.com/blog)

### 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
Expand Down

0 comments on commit 0c49121

Please sign in to comment.