[Documentation] Lets clean up the docs!

[isabellabrookes]

This is a multiparter and a nice way to get your name on some open source ❤️.

Readme.md needs a little extra love:

• [x] Set up a contributing.md file and pull info out (@DR-DinoMight - #117 )
• [x] Add set up for .env file. (@adilanchian provided)
• [x] Add setup for integrating gruveebackend repo (@adilanchian provided initial draft)
• [x] Add info for setting up own dev firebase (@maxemiliang - comment) -> @edburtnieks #142
• [x] Add setup for running Android emulator (@edburtnieks #142)
• [ ] Add videos of current Grüvee progress
• [ ] ...

Any suggestions/contributions welcomed! Comment, upvote, contribute, engage. 🖤

[maxemiliang]

I would like to add that instructions for setting up firebase would be really nice, kinda like this repo or something similar: https://github.com/janoodleFTW/timy-messenger

[ggoodwin]

If pod install throws this error

env: node: No such file or directory

[!] Invalid `Podfile` file: A JSON text must at least contain two octets!.

This may indicate your CocoaPods is out of date.

Running sudo gem install cocoapods should update you to the latest version even if an older version is installed.

[adilanchian]

I have started doing the .env file work !

[isabellabrookes]

If pod install throws this error

env: node: No such file or directory

[!] Invalid `Podfile` file: A JSON text must at least contain two octets!.

This may indicate your CocoaPods is out of date.

Running sudo gem install cocoapods should update you to the latest version even if an older version is installed.

I think this should be added to a "troubleshooting" portion of the guides.

[adilanchian]

Just checked of:

Add set up for .env file. (@adilanchian should provide a sanitized .env.local file for us 👍 ) Add setup for integrating gruveebackend repo

Still working through a couple things, but mainly I want to start adding videos of our progress in the proper branches and such:

Add videos of current Grüvee progress

[edburtnieks-private]

Hi!

Upon trying set up local development environment on Windows 10 machine I ran into few issues and decided to add some notes to documentation for anyone who has ran into similar issues.

The documentation and layout may need to be adjusted, because I only tried the setup on Windows 10 machine for Android development.

Added

• Missing .env variables
  • FIREBASE_PROD_URI
  • ALGOLIA_PROD_INDEX_NAME
• Note to switch to release-1.0 branch
• Info about google-services.json file to android development setup
  • Related to Add info for setting up own dev firebase checklist item under this issue. Maybe it would be better to extract it to separate Firebase section. Let me know what would be better.
• Start Android Emulator section
  • Related to Add setup for running Android emulator checklist item under this issue. This is a very quick and dirty Android emulator setup. I haven't got any extensive experience with Android Studio and emulators, but for what I could figure out, was enough. Let me know if it should be more detailed or improved.
• Note about android-start error on Windows 10

Pull request with changes: #142

[adilanchian]

@edburtnieks MUCH appreciated again. I just submitted some feedback for you here. Please let me know if it makes sense or you think certain sections should not be changed!

[adilanchian]

@isabellabrookes assigning this to you since you are writing some fancy scripts! Let's link this issue to it for PR review and such :)