Git Product home page Git Product logo

larp-resume-site's Introduction

LarpLog (Working Title)

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.

System Requirements

  • Ruby 2.4.0p
  • Rails 5.0.1
  • Postgres 9.6.2
  • Internet access

Getting started

  1. Fork the repo

The parent repo lives here

  1. 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

  1. Install RVM. We recommend installing RVM stable with ruby

\curl -sSL https://get.rvm.io | bash -s stable --ruby

  1. rvm use 2.4.0 to get the correct Ruby version

  2. gem install bundler for Ruby package management

  3. bundle install to get the Gemfile requirements

  4. 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.

  1. 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.

Workflow

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.

  1. Create your own fork of the larp-resume-site repo

  2. 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.

  1. 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

  1. Maintainers of the repo will review your pull request. When your pull request is approved we will squash and merge the commits.

  2. You can view open issues for the project on our waffle.io board. You can find our user stories on our trello board.

Core Contributors

larp-resume-site's People

Contributors

korey-enright avatar sublimemarch avatar cmho avatar thejessleigh avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.