/warhammer-aos

A REST API for Warhammer Age of Sigmar minis.

Primary LanguageGoMIT LicenseMIT

⚠️ ARCHIVED

Re-built from the ground up in the new and improved ✨ github.com/brittonhayes/warhammer ✨

Warhammer - Age of Sigmar API ⚔️

A REST API for public Warhammer Age of Sigmar data. Built with Go + Lambda.

Logo

Go Reference

Go Report Card

JSON Schema

Usage ⚡

The API is free and public. Try it out!

🌐 aos-api.com/armies

Docs 📝

Looking for API documentation? We've got 'em! Our documentation covers everything you can request from our API.

🌐 docs.aos-api.com

Development 🔧

Setup

If you'd like to contribute to the request handling and inner-workings of the API, you'll need a few things set up in your development environment.

  1. Install Taskfile.dev
  2. Setup Go
  3. Enjoy 🎉

Commands

# Build the lambda handlers
task build

# Run the lambda handlers locally
task invoke

# Run the tests
task test

Contributing

Wanna contribute your Warhammer mini data to the API?

We'd love your contributions! We've tried to make it as easy as possible for people to add their info without needing to understand the code.

Check out our contributing page to get started!

Show your support

Give a ⭐️ if this project helped you!