Bitcoin Ordinal Creator is a web application that allows users to create and manage Bitcoin Ordinals. This repository contains the front-end code for the application, built with React and TypeScript.
- Connect to Bitcoin wallets (supports Xverse and other compatible wallets)
- Create text and image-based Ordinals
- View existing Ordinals in the connected wallet
- Support for both Mainnet and Testnet
- Real-time balance checking
- Pagination for viewing large collections of Ordinals
- React
- TypeScript
- sats-connect (for wallet integration)
- Framer Motion (for animations)
- Tailwind CSS (for styling)
Before you begin, ensure you have met the following requirements:
- Node.js (v14.0.0 or later)
- npm (v6.0.0 or later)
- A compatible Bitcoin wallet (e.g., Xverse)
-
Clone the repository:
git clone https://github.com/your-username/bitcoin-ordinal-creator-frontend.git -
Navigate to the project directory:
cd bitcoin-ordinal-creator-frontend -
Install the dependencies:
npm install
-
Start the development server:
npm start -
Open your browser and visit
http://localhost:3000 -
Connect your Bitcoin wallet and start creating Ordinals!
- To switch between Testnet and Mainnet, use the toggle switch in the application UI.
- The API endpoint for the back-end server can be configured in the
.envfile:REACT_APP_API_URL=http://localhost:3002
Contributions to the Bitcoin Ordinal Creator are welcome. Please follow these steps to contribute:
- Fork the repository
- Create a new branch (
git checkout -b feature/your-feature-name) - Make your changes
- Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin feature/your-feature-name) - Create a new Pull Request
This project is licensed under the MIT License. See the LICENSE file for details.
If you have any questions or feedback, please open an issue on GitHub or contact the maintainer at brianchoffman@gmail.com.