Skip to content

Latest commit

 

History

History
80 lines (50 loc) · 3.22 KB

README.md

File metadata and controls

80 lines (50 loc) · 3.22 KB
Raw

Warhammer 40k Battlegrounds - API

Welcome to the Warhammer 40K Battlegrounds, a Pokémon-style battle clone set in the grimdark universe of Warhammer 40,000. This app brings the strategic elements of the 40K tabletop game to life by utilizing data sheets from the Warhammer 40k 10th Edition. Players can choose from a wide array of units, each with unique abilities and attributes, to engage in tactical battles. Whether you're a seasoned 40K veteran or new to the franchise, our app offers a thrilling and immersive experience that captures the essence of this epic universe.

Associated Front End

Getting Started

You can access the game on our production environment here Additionally, you make use of this backend by consuming our APIs listed below. Lastly, feel free to clone this backend and help us build up on it

Technology used

  • Rails 7.1.3
  • Ruby 3.2.2
  • Faraday
  • RSpec

Routes

Endpoint details via OpenAPI docs

All routes are GET

  • Base URL: https://intense-gorge-51639-2d7942788e0c.herokuapp.com/
  • GET /api/v1/factions - get all factions
  • GET /api/v1/factions/<faction_id>/units - get all units related to a faction

Error Conditions

Any error in query parameter values will likely respond with an error message that the faction could not be found. Double check you are passing faction id that is related to a faction

Getting Started

We welcome any and all contributions! Feel free to submit a Pull Request with your changes to make this a better API for everyone!

  1. Clone and download Github repo
  2. Install Gems: bundle install
  3. Setup database: rails db:{create,migrate}
  4. Run test suite: bundle exec rspec (100% of tests should be passing if everything was set up properly)

ER Diagram

image

40k Battlegrounds Architecture

image

Built With

Authors

Clyde Autin | clydeautin | LinkedIn

Chee Lee | cheeleertr | LinkedIn

Luis Aparicio | LuisAparicio14 | LinkedIn

Lance Butler | LJ9332 | LinkedIn

License

This project is licensed under the CC0 1.0 Universal Creative Commons License - see the LICENSE.md file for details

Acknowledgments

  • The Emperor
  • Trazyn the infinite