From 66a0f9d459afa3a8f1b5980254abd46e36ef2175 Mon Sep 17 00:00:00 2001 From: ccesar Date: Mon, 17 May 2021 11:57:35 -0300 Subject: [PATCH] Improve instructions to start the testrig And shows the Matrix room handle, to people using a homeserver differente than matrix.org --- CONTRIBUTING.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2c82ef2a7..cf79233ee 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ Check the [issues](https://github.com/superseriousbusiness/gotosocial/issues) to Before starting on something, please comment on an issue to say that you're working on it, and send a message to `@dumpsterqueer@ondergrond.org` (Mastodon) to let them know. -You can also drop into the GoToSocial Matrix room [here](https://matrix.to/#/!mdShFtfScQvVSmjIKX:ondergrond.org?via=ondergrond.org). +You can also drop into the GoToSocial Matrix room [#gotosocial:ondergrond.org](https://matrix.to/#/!mdShFtfScQvVSmjIKX:ondergrond.org?via=ondergrond.org). This is the recommended way of keeping in touch with other developers, asking direct questions about code, and letting everyone know what you're up to. @@ -54,6 +54,20 @@ docker run -d --user postgres --network host sosedoff/pgweb This will launch a pgweb at `http://localhost:8081`. +After spinning the database, you can start the gotosocial testrig using: + +```bash +./gotosocial testrig start +``` + +This will launch GTS at `http://localhost:8080` with pre loaded content. + +### ⚠️⚠️**WARNING**⚠️⚠️ + +`testrig` will drop all tables on exit, to ensure the next `testrig` starts with the same values. `testrig` also uses a in-memory storage, so, all attachments are lost on exit. + +You should **NEVER** run a testrig on the same database you use for an actual instance, because you will lose all your data on testrig exit. + ## Running tests Because the tests use a real Postgres under the hood, you can't run them in parallel, so you need to run tests with the following command: