skc-deck-api

README

skc-deck-api

Info

Go API that provides various functionality related to Yugioh deck building and deck lists. Below are some of the functionalities:

• Allow storage of deck lists - currently not everyone can submit a deck list, functionality might be opened later.
• Retrieve deck lists
• Get decks that feature a card

Local Setup

In order for the API to work locally, do the following steps

1. Run go mod tidy to download deps
2. Execute the shell script aws-secrets-local-setup.sh to download all the secrets. This will only work if you are logged into AWS and have access the secrets.

Testing

Command	Notes
go test ./...	Run all tests - no special perks
go clean -testcache && go test ./...	Clear cache and runs all tests again

There is also a shell script - test.sh that can be used to test the API.

Contact & Support

All info about the project can be found in the SKC website

If you have any suggestions or critiques you can open up a Git Issue

This project was made to improve the SKC site and introduce myself to a new programming language. If you want to support, it's real simple (and free) ➡️ subscribe to my channel on YT!

Usage

As of now, no one is permitted to use the API in any way (commercial or otherwise). The reason is, I don't have money to support multiple instances and environments. If multiple calls are being made outside of my immediate vision, the performance will degrade and it's original purpose will be compromised.

If you need an API for teaching/education purposes (not commercial), check out the SKC API

Otherwise, if you want to use this API for your projects, you can expedite the process of multiple instances being spun up by subscribing and watching my content on YT. Again, this is free and will allow me to offset projects like this with YT Monetization.