Skip to content
Matthew Pfister edited this page Apr 2, 2020 · 23 revisions

Table of Contents

Application Architecture

Helping Out

Web Architecture

    Dependency List

    Folder Structure

    Commands

Welcome! So you're looking for a "free" magic the gathering league manager, huh? Well you've come to the right place. Don't worry about the quotes around free, you don't have to pay anything to get all the parts to this app. Everything is open source. However, depending upon how many players you have accessing the league manager, on a daily basis, will determine the bill you get from AWS. Don't worry I'll go through how to build everything. It's really easy. Just some light reading and a few lines in the terminal and your there.

However I know the terminal will scare people, but this app is free, so it shouldn't surprise you that some assembly is required. Albeit as it may, if it does, well then maybe you should just drop off here...

...You stayed! Yay! Let's get started.

Application Architecture

The application is split up in to four different parts: the infrastructure project, the web/FE, the API/BE (which is a collection of micro services), and the service SDK. These four domains work together so they'll need to be built, and deployed together. Don't worry, I've got some code to do most of the heavy lifting for you. You can find all the repositories with the appropriate code below.

Helping out:

If you get the itch to help, or you feel like you have an idea to improve the site, great! However, I'm going to have to ask you to fork the repo. That way you can have your own copy, and when you feel your changes are ready you can merge it back in to the original. This is to avoid having a million branches on a single repo, and for you to have a copy of those changes even if they don't make it in to the original.

To get forking, do the following:

  1. Click the fork button, in the top right corner of the repo's GitHub page, that looks like the image below:

fork-btn

  1. After clicking the button, a modal should appear asking you where you would like to fork the project too. Click on the desired account you want it copied under.

fork-modal

  1. Then once it's done, navigate to your new forked repo and click on the large green clone button.

clone-btn

  1. A dropdown should open up with a link to clone the repo via ssh. Click the clipboard button to copy the link.

clone-modal

NOTE: You can also clone the repo via https. Just click the Use HTTPS button in the top right corner of the dropdown to update the link.

  1. After you've copy the link, open up a terminal of your choosing, navigate to the folder you want the code to be copied to, and run git clone -u [copied ssh/https link].

  2. That's it! Happy programming!

Clone this wiki locally