jgraycar / Kamaete-API

https://kamaete-api.herokuapp.com
0 stars 1 forks source link

Kamaete API

This is the backend code for Kamaete, using Ruby on Rails 5 in API only mode.

To see the source code for the frontend, check out the corresponding repo.

Entity-Relationship Diagram

ER Diagram

Contributing

To contribute to this project, please follow the following steps:

  1. Fork this repository on the GitHub website, then clone your repository onto your computer:

    $ git clone git@github.com:[Your GitHub Account]/Kamaete-API.git
  2. Go into the Kamaete-API directory

    $ cd Kamaete-API
  3. Keep track of any changes made to the original repository by adding a remote named upstream:

    git remote add upstream https://github.com/jgraycar/Kamaete-API.git

    To sync any changes made with your own repository, run the commands

    git fetch upstream
    git merge upstream/master

    and fix any merge conflicts that arise.

  4. Run the setup script and follow the prompts to install all required dependencies

    $ bin/setup

    This will also create the development database and (once I write a seed file later) seed it with preset resources.