pokemon-tcg-dex

module
v0.0.0-...-54f9dea Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 7, 2024 License: Apache-2.0

README

Pokémon TCGDex

Pokémon TCGDex is a management system for Pokémon TCG collections, designed to make it easier to organize, track, and explore your cards. Whether you're a casual collector or a dedicated TCG enthusiast, TCGDex helps you manage your collection effortlessly.

I created the system because I thought it would be nice to horn my skills in different languages. The projects is in constant evolution and any feedback great!

Features

  • Collection Management: Keep track of your Pokémon cards and organize them with ease.
  • Image-Based Search: Snap a picture of your card and search the database for instant identification.

Requirements

  • Golang: Version 1.22 or higher
  • Python: Version 3.11 or higher

Getting Started

Follow these steps to set up and run the application.

Setup
  1. Install dependencies:

    pip install uv
    
  2. Bring up the application services:

    make docker-up
    
  3. Apply database migrations:

    make migrate-up
    
  4. Build the application:

    make build
    
  5. In a separate terminal, start the sidecar service (it is needed to compute the embeddings):

    make sidecar
    
  6. Initialize the database:

    make db-setup
    
Running the Application

In separate terminal windows, run the following commands:

  1. Start the sidecar service (if it is not already started):

    make sidecar
    
  2. Launch the API:

    make api
    
  3. Run the front-end:

    make front
    

With TCGDex, managing your Pokémon TCG collection has never been easier. Happy collecting!

Directories

Path Synopsis
src
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL