This application is designed to keep track of, and allow online gaming with your characters for Chronicles.
This readme concerns setting up the environment, to you can help develop this application.
It's required that you have a few things installed, before you can run this application locally.
- You need to have ruby 2.0.0-p0 or later installed.
- You need to have mongodb running on your machine.
- You need to have git installed.
- Clone the repository by running
git clone git@github.com:ekampp/chronicles.git chronicles - You need to copy a few files:
- Copy
.env.exampleto.env - Copy
config/mongod.conf.exampletoconfig/mogod.conf
- Open your terminal and run
foreman start
You should now be able to view the application on localhost:5000.
If you are on a mac, you can use homebrew to install most of the binaries and rbenv for managing the ruby versions.
The application is build from the TDD pholosofy, so before you implement anything, you should write the test, and make sure it fails (because you haven't implemented the feature yet). The implement the feature, and make sure the test passes.
You can start a continuos testing server on your local machine using guard.
The tests should be written using rspec and capybara.
If you have ant questions, you can mail me at emil@kampp.me