]>
Commit | Line | Data |
---|---|---|
1 | # Forum | |
2 | ||
3 | A forum for the year 3000. | |
4 | ||
5 | ## Running the server | |
6 | ||
7 | This project provides a [docker compose][docker-compose] configuration | |
8 | to easily run the service. In order to run the server, run | |
9 | `docker-compose up` | |
10 | ||
11 | ## What you will need to get started | |
12 | ||
13 | This project uses [node][node] for most of its development processes. | |
14 | Once you have node installed according to the instructions there, run | |
15 | `npm install` from the root of the project. | |
16 | ||
17 | For local development serve the page by running `npm watch` from the | |
18 | root of the project. | |
19 | ||
20 | ## Installing git hooks | |
21 | ||
22 | This repo contains a pre-commit git hook so indent will run before every | |
23 | commit. Run `npm run setup-hooks` to install it. | |
24 | ||
25 | ## Running migrations on the docker environment | |
26 | ||
27 | After building the app with docker compose, you can set up the database | |
28 | with `docker exec forum_forum_1 npm run db:setup`. This will run | |
29 | migrations and seed default data. | |
30 | ||
31 | If you only want to run migrations, you should run | |
32 | `docker exec forum_forum_1 npm run db:migrate` instead. | |
33 | ||
34 | If you only want to seed the database, you should run | |
35 | `docker exec forum_forum_1 npm run db:seed` instead. | |
36 | ||
37 | [node]: https://nodejs.org/en/ |