Update setup documentation

Pocket / curation-tools-frontend

DEPRECATED

Mozilla Public License 2.0

10 stars 52 forks source link

Update setup documentation #124

Closed nina-py closed 3 years ago

nina-py commented 3 years ago

Goal

Keep the docs updated as the code evolves.

Implementation Decisions

Updated script name to run to generate data for the local API and path to generated db.json file.
Reworded the section on starting up the local GraphQL server to make it clear that the main point of entry is the app, not the GraphiQL editor used for running test queries or debugging them.
Added a section on updating generated types and helper functions for the local API.

nina-py commented 3 years ago

@jpetto, good point. What causes this is still only a theory, but all three of us have had this issue by now and it needs to be included in the docs.

nina-py commented 3 years ago

@jpetto FYI - previous discussion of the blank screen issue: https://github.com/Pocket/curation-tools-frontend/pull/122#issuecomment-776939657. For me, only the reboot fixed everything, but Kelvin managed to get it working without a reboot.

nina-py commented 3 years ago

Hi @jpetto, I've updated the docs - after some experimentation, I found this happens when, after an update to the schema or queries, you restart the local GraphQL server and the frontend up. Both need to be powered down and started up again, and if the structure of the data has been updated, a fresh run of the api:generate-data script is also needed.

Please let me know if my instructions for fixing this are clear enough - if not I'll expand them into a step-by-step process so that anyone new to this repo doesn't have to look up the commands elsewhere on the page.

nina-py commented 3 years ago

Hi @jpetto, just noticed that this PR is still outstanding, perhaps because the status says "Changes requested"? I can't see anywhere where I can respond to this request for changes so that the reviewer gets notified so I'm hoping you see this message instead! :)