aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRuben Beltran del Rio <ruben@unlimited.pizza>2021-04-15 23:18:09 +0200
committerRuben Beltran del Rio <ruben@unlimited.pizza>2021-04-15 23:18:09 +0200
commitf088a6594c15951b85a56129944afa51a62dc765 (patch)
treee49f3f8d60d4f78c3e7591d34ff8b15ae673351c /README.md
parent58f7d52150456713d3132408668a92d0f6f3d084 (diff)
Update the config
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 4 insertions, 23 deletions
diff --git a/README.md b/README.md
index e576933..ac80064 100644
--- a/README.md
+++ b/README.md
@@ -2,36 +2,17 @@
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.
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
+For local development serve the page by running `npm run dev` 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.
-
-## 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.
+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