LarpLog is a tool for larpers to record games and runs that they've played so they can keep track of memories and gamers. This is an independent project inspired by Larp Resume. However, after using it, we wanted to expand functionality and add more granular privacy control for users so they can better curate their larp memories and experiences online.
- Ruby 2.4.0p
- Rails 5.0.1
- Postgres 9.6.2
- Internet access
- Fork the repo
- Clone your fork to your local machine
HTTPS: https://github.com/your_username/larp-resume-site.git
SSH: [email protected]:your_username/larp-resume-site.git
- Install RVM. We recommend installing RVM stable with ruby
\curl -sSL https://get.rvm.io | bash -s stable --ruby
-
rvm use 2.4.0
to get the correct Ruby version -
gem install bundler
for Ruby package management -
bundle install
to get the Gemfile requirements -
brew install postgres
to get Postgres. We are using version 9.6.2 at the time this project is created.
Follow instructions in your terminal after postgres is done installing to get postgres running locally on your machine.
- Run
rake setup
to create the development and test databases that will be used in this project. NOTE: this will drop (if they exist) then create the databases. Active rails sessions interfere with this process. Be aware of this.
NOTE: This project has adopted the Contributor Covenant as our Code of Conduct. We use the latest version available on the contributor covenant website. Please refer to The Contributor Covenant Website for more information.
-
Create your own fork of the larp-resume-site repo
-
Make changes in a local branch of your fork. Open a pull request from your fork to the parent repo's master branch when you are ready to check in your work.
We use WaffleBot integration! It's pretty cool. To use it, when you create a branch for an issue, name the branch like this:
[issue-number]-name-of-branch
for instance: 3-add-rake-setup-task
Please resolve merge conflicts before requesting a review from one of the maintainers.
- A note on commit messages:
When you create a commit message, please make it descriptive. If your commit message is directly related to an open issue, please include closes #[issue-number]
. For instance: closes #3