chronoscio / frontend

Frontend repository for the ChronoScio project
https://chronoscio.now.sh
GNU General Public License v3.0
3 stars 0 forks source link

PoC with Github #5

Closed amaury1093 closed 6 years ago

amaury1093 commented 6 years ago

This PR introduces a PoC which stores all user modifications on Github.

The flow

The test repo where this PoC is implemented is currently https://github.com/amaurymartiny/interactivemap. It has one territory.json file, you can check its history to see all users changes. If we approve this PoC, then a separate repo under the interactivemap organisation should be created for this purpose, with a folder hierarchy to organize territories efficiently.

Tutorial

This PoC is not robust yet, clicking a bit everywhere might lead to bugs, so I recommend to follow this tutorial.

  1. @ataalik @whirish I sent you an invite to collaborate on https://github.com/amaurymartiny/interactivemap. You need to accept this first. Anyone reading this and wants to try it out, send me a message and I'll add you too.

  2. On page load, you should see a map centered around London with a blue polygon (representing a territory, taken from territory.json in the above repo).

  3. Login on the top right. Since the backend is not ready yet for authentication, I used Auth0 for now. We can choose to use Auth0, or a home-made one, in the future. Auth0 will ask for your Github repo login.

  4. After redirection, you should rearrive at the map, with Logout on the top right, which means you are logged in. You can try to log out/back in if you want.

  5. Once logged in, you can start modifying the polygon by clicking on it. Click multiple times, try drag'n'dropping the vertices. The UX on this one could be improved.

  6. Once you're happy with the modifications, click Save on Github. For this one, I recommend you opening the browser console, to see what's happening (and send me logs if there are bugs). Careful to click only once on this button!

  7. If everything is successful, the polygon should turn all blue again. Now head to https://github.com/amaurymartiny/interactivemap to make sure your commit is correctly pushed.

vercel[bot] commented 6 years ago

This pull request is automatically deployed with Now.

To access deployments, click Details below or on the icon next to each push.

amaury1093 commented 6 years ago

@whirish I'll close this one for now, and create another for authentication only (taking pieces of this one).