Yugioh Pack Opener

This is a web app that enables users to be able to generate and mock pack openings for use on online drafting for yugioh.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

![YugiohPackOpener][site-screen-shot]

This is a project is built using Fast API(python), React(js) and Flutter. We will be making the entire stack free and opensource so if you would like to host all the pieces yourself you can otherwise we will be making sure it is up and ready at https://yugioh-pack-opener.gxldcptrick.dev

This is actively being worked on so please feel free to open any issues or suggest ideas in our issues. We are all working fulltime so it will be a minute before we can get to everything but we will be working on it.

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

You will need to install dependencies for: python, node, docker to be able to fully build and run the project locally.

• yarn

  npm install yarn@latest -g

• python 3.10.4

  # using pyenv
  pyenv install 3.10.4

Installation

1. Clone the repo

   git clone https://github.com/gxldcptrick/Yugioh-Pack-Opener.git

2. Use Docker Compose to build the apps for you in Docker

   # to run the containers without locking your terminal
   docker-compose -f docker/docker-compose.yml up -d 

(back to top)

Usage

You can interact with the api using postman like

# Lists cards that are being tracked by the system.
curl --location 'https://localhost:8082/api/v1/cards'

# Lists sets that are being tracked by the system
curl --location 'https://localhost:8082/api/v1/sets/'

# Generates a Pack that you opened
curl --location 'https://localhost:8082/api/v1/packs/open/' \
--header 'Content-Type: application/json' \
--data '{
    "selections": [
        {
            "packId": "some-set-id",
            "totalDesired": 1 
        }
    ]
}'

For more examples, please refer to the Documentation

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the Apache-2.0 license. See LICENSE for more information.

(back to top)

Contact

Milo - me@gxldcptrick.dev

Project Link: https://github.com/gxldcptrick/Yugioh-Pack-Opener

(back to top)

Acknowledgments

• Frontend Engineer Dean-Pesek: Dean Pesek
• Mobile Engineer vCertxfiedGoat: Alexander Quintanilla aka The Goat

(back to top)