Documenting information to help new developers

[taksuyu]

This project wasn't intended to be open sourced this early and that has left the codebase in rough shape for anybody new to work on the project.

While the overall structure of the program wouldn't be changed, we can come up with a way to share information about how the server works and shape what the collaborative development process would be like for a new developer.

Any feedback on what or how things could be improved is welcomed.

[kammitama5]

Hi :) I'd like to know how to get this project up and running and if any builds have been tested with it (I have Ubuntu 14.04 i386 and Ubuntu 18.04 64bit which I can test if that is of use to you (if it builds, if it's slow or chokes, and browser compatibility, etc). I can guinea-pig test that to see what it builds or doesn't build on, which might be helpful for new people who want in on collaborating. Also doc-strings or where people can file issues or that contributions are welcome might be of use to some people.

[taksuyu]

@kammitama5 Hey! Thanks for the response!

Currently the project should build with any recent version of stack. I'm pretty sure the version of stack on Ubuntu 14.04 repos won't work cause of a core package name resolution bug that happened ~1 year ago.

You shouldn't need to do any specific setup for the master branch currently. sessions currently uses redis and you'd have to set that up on a specific port.

With stack you should be able to run

$ stack build
$ stack exec tabletop

Before I merge sessions I'll see about introducing configuration through a file so people won't have to setup redis just to test locally.

If you're interested in messing around with the desktop client you'll have to visit taksuyu/tabletop-client. I'll try to include decent instructions on that repo as well :)

Let me know if you run into any issues!