TCG Card Builder is a React-based application that allows users to create custom trading card game (TCG) cards for games like Lorcana and Yu-Gi-Oh. Users can select templates, customize attributes such as card type, names, abilities, power levels, rarity, and upload custom artwork. Finished cards can be exported as images or PDFs for easy sharing and printing.
https://tcgbuilder.netlify.app/
- Template Options: Choose from various card types such as:
- Character
- Action
- Magic
- Trap
- Fusion
- Customization:
- Enter custom card names and abilities.
- Adjust power levels, rarity, and other attributes.
- Upload custom artwork for your cards.
- Export Options:
- Save your cards as images.
- Generate PDF versions for easy sharing or printing.
- Lorcana
- Yu-Gi-Oh
- Pokémon (Coming Soon!)
- Magic: The Gathering (Coming Soon!)
To run the project locally, follow these steps:
- Clone the repository:
git clone https://github.com/your-username/tcg-card-builder.git
- Navigate to the project directory:
cd tcg-card-builder
- Install dependencies:
npm install
- Start the development server:
npm start
If you prefer to use Docker for development or deployment, you can follow these steps:
-
Ensure you have Docker and Docker Compose installed on your system.
-
Clone the repository:
git clone https://github.com/your-username/tcg-card-builder.git
-
Navigate to the project directory:
cd tcg-card-builder
-
Build and run the Docker container:
docker-compose up --build
This will build the app, install dependencies, and serve it using Nginx on port 3000.
-
Open your browser and visit:
http://localhost:3000
To create a production-ready build locally using Docker:
- Run
docker-compose up --build
to rebuild the container. - After the build process completes, the app will be available on
http://localhost:3000
.
Alternatively, you can run the build without Docker using the following command:
npm run build
The project uses the following key libraries:
- React - Core framework for building the application.
- @react-three/fiber and @react-three/drei - For 3D rendering and custom effects.
- html-to-image and html2canvas - For exporting cards as images.
- jspdf - For exporting cards as PDFs.
- tailwindcss - For styling components.
Available scripts for development and production:
npm start
: Starts the development server.npm run build
: Builds the app for production.npm test
: Runs the test suite.
This project is licensed under the MIT License.