From 7360dbc77b9aa56fdb5f2fef8e480a0f7a78e0d1 Mon Sep 17 00:00:00 2001 From: kumavis Date: Thu, 22 Nov 2018 01:49:33 -0500 Subject: [PATCH] readme - document test procedure it doesnt seem to be documented anywhere that you need to remove the data for the tests to work --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 410510ae..9ca1ee5c 100644 --- a/README.md +++ b/README.md @@ -170,6 +170,14 @@ This would not be possible without **community contributors**, big shout out to: I am missing many others, apologies, will be adding them soon! +## Testing + +Tests may be run with `npm test`. Tests will trigger persistent writes to the DB, so subsequent runs of the test will fail. You must clear the DB before running the tests again. This can be done by running the following command in the project directory. + +```bash +rm -rf *data* +``` + ## Deploy To quickly spin up a Gun test server for your development team, utilize either [Heroku](http://heroku.com) or [Docker](http://docker.com) or any variant thereof [Dokku](http://dokku.viewdocs.io/dokku/), [Flynn.io](http://flynn.io), [now.sh](https://zeit.co/now), etc. !