michaeljolley / number-one

A container based Twitch chat bot that provides chat commands, overlays, video interaction and more.
MIT License
32 stars 13 forks source link

CONTRIBUTING.md - Update Fauna instructions to include DB & Collection setup #42

Open MaryJoStaebler opened 4 years ago

MaryJoStaebler commented 4 years ago

Is your feature request related to a problem? Please describe. While setting up the project, the Fauna portion was failing upon running. Ended up I needed to create a DB & Collections (users,streams) in Fauna.

Describe the solution you'd like Update instructions to create DB and the two current collections in the code (users, streams).

Describe alternatives you've considered Maybe have a setup inside the project to automate setting this up.

Additional context I also had to create a api key with the DB settings instead of the global one per mention in the docs.

michaeljolley commented 4 years ago

I like the idea of creating the collections/db for you but I don't like the idea of asking someone for a global api key. I wouldn't want to add a key with access to all by db's.

Should we (vote with reactions):

🎉 Update the CONTRIBUTING.md to instruct the person to create the database/collections and then add their database level api key ❤️ Update the CONTRIBUTING.md to instruct the person to create the database only and add their database level api key. Then automatically setup the collections on first run 🚀 Ask for the global api key and automatically create the database/collections

If you have an alternative comment below.

michaeljolley commented 4 years ago

@allcontributors please add @MaryJoStaebler for ideas

allcontributors[bot] commented 4 years ago

@MichaelJolley

I've put up a pull request to add @MaryJoStaebler! :tada:

parithon commented 4 years ago

Fauna does have a CLI tool we can use to accomplish this via script: fauna-shell

OOo... there is a Fauna docker container for a development option too.

michaeljolley commented 4 years ago

I think we can do it with FQL as a part of the startup.

That option for docker for development is a really cool idea.

michaeljolley commented 3 years ago

I've added instructions re: collections & indexes to the contributing.md for now.