X-Git-Url: https://git.r.bdr.sh/rbdr/forum/blobdiff_plain/5a2bb071a8d88c0a87b8a6e1d1105a8ffb363648..e7f6de3d196ec1bf392056c504c2bc7b86e40ca0:/README.md diff --git a/README.md b/README.md index 0ab0174..ac80064 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,18 @@ # 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 run dev` from the +root of the project. + +This project depends on the [forum server][forum-server], so make sure +that's running before starting. + +[node]: https://nodejs.org/en/ +[forum-server]: https://gitlab.com/rbdr/forum-server