Dungeons and Buddies is a MUD-based online game that supports playing with multiple players in real time. For the current status of the project, see: Alpha Release 0.1.0.
Prerequisites
This project assumes that you have Docker installed. To set up Docker, see their getting started guide.
Clone the project to your local machine.
git clone https://github.com/codebuddies/dungeonbuddies.gitMake sure you're in the develop branch as this is our default branch.
git checkout developIf you're launching the project for the very first time, build the Docker containers.
docker-compose up --buildThis should build and launch the project using Docker. Once it is finished, your local version of the app should be accessible by going to localhost:3000 in your browser. You can see that this works if you see a Welcome screen.
Docker Notes
To stop all Docker services, run docker-compose stop. Alternatively, running docker-compose start will start them again.
To stop services and delete your containers, run docker-compose down.
For additional commands, run docker-compose in your terminal.
Important: To use Gemfile commands such as bundle, rspec or other rails commands, run them against the docker services. To use these commands, append them with docker-compose exec web <command>. For example:
docker-compose exec web rails generate migration AddPartNumberToProductsdocker-compose exec web rspecdocker-compose exec web bundle installBranching
The master branch is saved for deploying releases to production.
develop is set as our default development branch. When working on an issue, for the most part, you'll be branching off of develop. For example:
# Tip: In order to keep focus on what your goals are for the branch, name it as
# an activity of what you are working on.
git checkout -b add-user-authentication developA Note on Commit Messages
Make sure to commit often and write your commit messages in present tense as notes to others (and yourself) of the changes that is happening.
# The first line should be a generalized statement of what you're committing.
Set up User model for authentication
#
# The second and after lines should be more of a detailed statement of
# what you are changing in your commit.
Create `User` model.
Add validations to email attributes.Submitting PRs
When you are ready for a review or have questions, feel free to use push your code back to the repository to create a Pull Request.
The base branch should be whatever branch you want your branch to merge into. Typically, the compare option should be selected with your working branch.
Title your PR to the generalized topic of your work. In the body, reference any issues it's related to and write a clear description of your work.
Try to seek someone to review your code.
Assign the PR to yourself and others who contributed to your code.
Label accordingly:
in-progress is for PRs that are not merge-ready.feedback wanted to let others know you're open to feedback and a reviewready for review to let others know that you're ready for an official code reviewready to merge to let people know that this PR is good to merge with it's parent branch.Dungeons and Buddies is released under the MIT License.