From 0fef95347c9f0d0605b70683dbd6620f78bd4219 Mon Sep 17 00:00:00 2001 From: Nolan Lawson Date: Sun, 18 Feb 2018 14:38:10 -0800 Subject: [PATCH] update readme --- README.md | 42 +++++++++++++++++++++++++++++++++++++++++- package.json | 2 +- 2 files changed, 42 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9981cffe..92070225 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,43 @@ # Pinafore -A mobile-optimized web client for [https://joinmastodon.org](Mastodon). \ No newline at end of file +An alternative web client for [Mastodon](https://joinmastodon.org]). + +## Building + + npm install + npm run build + PORT=4002 npm start + +## Development + + npm run dev + +## Testing in development mode + +In separate terminals: + +1\. Run a Mastodon dev server (note this destroys the `mastodon_development` database and inserts canned data): + + npm run run-mastodon + +2\. Run a Pinafore dev server: + + npm run dev + +3\. Run a Cypress dev environment: + + npm run cy:open + +If you want to export the current data in the Mastodon instance as canned data, so that it can be loaded later: + + npm run backup-mastodon-data + +## Testing + +Lint: + + npm run lint + +Run Cypress tests: + + npm test \ No newline at end of file diff --git a/package.json b/package.json index 9cd07f2f..6d306700 100644 --- a/package.json +++ b/package.json @@ -19,7 +19,7 @@ "wait-for-mastodon-to-start": "node bin/wait-for-mastodon-to-start.js", "globalize-css": "node ./bin/globalize-css.js", "deglobalize-css": "node ./bin/globalize-css.js --reverse", - "backup-mastodon-for-tests": "pg_dump -Fc mastodon_development > fixtures/dump.sql && cd mastodon/public/system && tar -czf ../../../fixtures/system.tgz ." + "backup-mastodon-data": "pg_dump -Fc mastodon_development > fixtures/dump.sql && cd mastodon/public/system && tar -czf ../../../fixtures/system.tgz ." }, "dependencies": { "@gamestdio/websocket": "^0.2.2",