]> git.r.bdr.sh - rbdr/forum/blobdiff - README.md
Add jest for testing
[rbdr/forum] / README.md
index 0ab0174399336b5518872bb0c8680fe0f2f91fda..ac80064099a1b70881cb74ca45578358cf4a88c4 100644 (file)
--- 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