hammlab / Crowd-ML

Framework for Crowd-sourced Machine Learning

Apache License 2.0

16 stars 10 forks source link

Setup docs #14

Closed 3ygun closed 7 years ago

3ygun commented 7 years ago

Goal

Redo the README content to improve understanding for a new user.

Parts

[x] Fix a lot of the formatting problems across the README's: headers, syntax highlighting, indentation, etc.
[x] Add a Dockerfile for environment independent server setup
[x] Confirm all changes work with @tylermzeller as my Android app wasn't working correctly

Remaining

Once I can talk to Tyler This should be ready to merge. Please feel free to review the changes. The largest set of changes are to the firebase/readme.md so at least look at that one 🌵

tylermzeller commented 7 years ago

We should confirm with @jihunhamm that Docker is a good addition to this project. ~~I have no problems working with it, but~~(see comment below) I was told that the code base should be as simple as possible.

Open an issue for the crashing app as well and assign me, por favor.

tylermzeller commented 7 years ago

AHH! I just remembered that Docker and Android don't work well together. That is, the Android emulator cannot run while Docker is also running. I ran into this error while trying to do work after I had installed Docker for our capstone project.

3ygun commented 7 years ago

@tylermzeller I added a warning to notate that issue to the reader in server/readme.md see 16047b2

3ygun commented 7 years ago

All desired parts passing. @jihunhamm could you comment on if you want the Dockerfile to run the server?

Dockerfile reasoning from @3ygun: Have an isolated docker container for the server to execute within. Implemented as Dockerfile and updated server README with setup instructions.

@tylermzeller reviewed the README changes (see branch) for most project README's in server/, firebase/, client/Android/, etc.