update readme

This commit is contained in:
Nolan Lawson 2018-02-18 14:38:10 -08:00
parent 8e633e3870
commit 0fef95347c
2 changed files with 42 additions and 2 deletions

View File

@ -1,3 +1,43 @@
# Pinafore # Pinafore
A mobile-optimized web client for [https://joinmastodon.org](Mastodon). 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

View File

@ -19,7 +19,7 @@
"wait-for-mastodon-to-start": "node bin/wait-for-mastodon-to-start.js", "wait-for-mastodon-to-start": "node bin/wait-for-mastodon-to-start.js",
"globalize-css": "node ./bin/globalize-css.js", "globalize-css": "node ./bin/globalize-css.js",
"deglobalize-css": "node ./bin/globalize-css.js --reverse", "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": { "dependencies": {
"@gamestdio/websocket": "^0.2.2", "@gamestdio/websocket": "^0.2.2",