This is the back end for Scrumboard. Good to see you! See sb-angular for a description of this project.
You'll also need to clone and run https://github.com/rileypb/sb-angular.
If you need help setting up Scrumboard, please contact me at [email protected]
After cloning the repository, install the dependencies with bundle install.
Run rails s. This will start the server at http://localhost:3000. Navigating there will yield a "not authenticated" message since you must supply a token for access.
At this time, Scrumboard only supports authentication through Auth0, although it should work with any of the login methods available there.
To set up Auth0 authentication, create an account at auth0.com. Use the free plan for now. You'll get your own "domain" which will most likely be some random string.
Next create an API, which essentially is just a universally unique string identifier naming your API, i.e., the service that needs to authenticate users - the back end. This could be, for instance, https://<my.domain.com>/scrumboard.
Then create an application. The name doesn't matter, but it must be in your domain (I believe this is your only choice on the free plan). It will come with its own Client ID and Client Secret. The Client ID will be necessary for setting up the back and front ends.
You then need to add an auth0 section to your encrypted credentials:
auth0:
api_identifier: https://<my.domain.com>/scrumboard
domain: https://<my-domain-name>.us.auth0.com/
Remember not to commit your keys to git if you've forked this repo!
Scrumboard is licensed under GPLv3. This means that you can use this software for any purpose you want, and you can create derivative works, but you must license those derivative works under GPLv3 as well, and share the source code.
We've chosen this license because we want Scrumboard to be a tool for educators, and not the kernel of a proprietary project management product.