aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBen Beltran <ben@nsovocal.com>2020-03-22 11:53:13 -0600
committerBen Beltran <ben@nsovocal.com>2020-03-22 11:53:13 -0600
commit3841606684ee3d233266ad490905076a3562842c (patch)
tree407adde62e5181cae2b0d3611bc6c18c00a20d67 /README.md
parent00a6e8aa8dd06f8a2bd7ccccdccfcb6215cf4841 (diff)
Remove server
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index a07c14e..e576933 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,12 @@
A forum for the year 3000.
+## Running the server
+
+This project provides a [docker compose][docker-compose] configuration
+to easily run the service. In order to run the server, run
+`docker-compose up`
+
## What you will need to get started
This project uses [node][node] for most of its development processes.
@@ -16,4 +22,16 @@ root of the project.
This repo contains a pre-commit git hook so indent will run before every
commit. Run `npm run setup-hooks` to install it.
+## Running migrations on the docker environment
+
+After building the app with docker compose, you can set up the database
+with `docker exec forum_forum_1 npm run db:setup`. This will run
+migrations and seed default data.
+
+If you only want to run migrations, you should run
+`docker exec forum_forum_1 npm run db:migrate` instead.
+
+If you only want to seed the database, you should run
+`docker exec forum_forum_1 npm run db:seed` instead.
+
[node]: https://nodejs.org/en/