Skip to content

benruwel/HeroSquad

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Hero Squad

Create squads, heroes and join the battle for justice!

Ben Ruwel

Table of Contents

About The Project

This is a fun app that allows users to create squads with custom heroes and with custom strengths and weaknesses.

A hero can only belong to one squad if the member list is not full.

Built With

This is program is wholely written in Java and built with

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

In order to build this app locally, first make sure you have all the programs listed in Built with

Installation

  1. Clone the repo

    $ git clone https://github.com/benruwel/HeroSquad.git
  2. Wait gradle to install all the dependencies automatically

Usage

To build this project:

  1. Open your preferred terminal

  2. In your project's root directory run the project with

    $ gradle run
  3. Then navigate to localhost:4567 to view the page

BDD

This project is used to illustrate the concept of creating Objects within Objects. In our case scenario, a single instance of a Hero object should be created in only one other instance of the Squad object.

POST squads/new and POST heroes/new methods create a new instance of the squad and hero squad respectively.

POST heroes/new creates an object within an already created squad instance using the the instance's id. This id is set equal to its position on the Arraylist object which consists of all the created squad instances.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

My email - ruwelmwangi@gmail.com

Project Link: https://herosquad-benruwel.herokuapp.com/

Acknowledgements