diff options
| author | Ben Beltran <ben@nsovocal.com> | 2019-12-23 00:26:29 +0100 |
|---|---|---|
| committer | Ben Beltran <ben@nsovocal.com> | 2019-12-23 00:26:29 +0100 |
| commit | 1be5af9305937d4def3bf190b72e4e5450e989cb (patch) | |
| tree | 68373b7e16094cf9f0f3afb26fab2bc0bd2709bc | |
| parent | 890274a7b3ac70848ba9973ef33d53ed58ff88a8 (diff) | |
Add a README
| -rw-r--r-- | README.md | 18 |
1 files changed, 17 insertions, 1 deletions
@@ -1,3 +1,19 @@ # Forum -A forum system for the year 3000
\ No newline at end of file +A forum for the year 3000. + +## What you will need to get started + +This project uses [node][node] for most of its development processes. +Once you have node installed according to the instructions there, run +`npm install` from the root of the project. + +For local development serve the page by running `npm watch` from the +root of the project. + +## Installing git hooks + +This repo contains a pre-commit git hook so indent will run before every +commit. Run `npm run setup-hooks` to install it. + +[node]: https://nodejs.org/en/ |