{"id":13632416,"url":"https://github.com/tqtezos/minter","last_synced_at":"2025-04-18T02:32:57.891Z","repository":{"id":49412067,"uuid":"279416490","full_name":"tqtezos/minter","owner":"tqtezos","description":"OpenMinter is dApp framework for enabling the creation and collection of non-fungible tokens (NFTs) on Tezos.","archived":true,"fork":false,"pushed_at":"2022-02-28T20:38:34.000Z","size":4908,"stargazers_count":192,"open_issues_count":39,"forks_count":91,"subscribers_count":16,"default_branch":"main","last_synced_at":"2024-11-09T00:34:45.434Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tqtezos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"code_of_conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-13T21:34:31.000Z","updated_at":"2024-07-11T21:25:54.000Z","dependencies_parsed_at":"2022-08-23T11:51:16.887Z","dependency_job_id":null,"html_url":"https://github.com/tqtezos/minter","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tqtezos%2Fminter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tqtezos%2Fminter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tqtezos%2Fminter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tqtezos%2Fminter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tqtezos","download_url":"https://codeload.github.com/tqtezos/minter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249414252,"owners_count":21267724,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T22:03:02.634Z","updated_at":"2025-04-18T02:32:57.597Z","avatar_url":"https://github.com/tqtezos.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"![OpenMinter header](/docs/assets/minterhead.png)\n\n[![](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE) [![](https://img.shields.io/github/v/release/tqtezos/minter)](https://github.com/tqtezos/minter)\n\n## OpenMinter\n\nOpenMinter is dApp framework for enabling the creation and collection\nof non-fungible tokens (NFTs) on Tezos. The dApp enables anyone to\ncreate an NFT by filling in just a few fields, create new collection\ncontracts, see their NFTs across contracts, and enable marketplace\ncapabilities to trade them.\n\n### Notice\n\nThis software is in beta. At the moment, the [smart contracts](https://github.com/tqtezos/minter-sdk)\nthat OpenMinter uses have **not** been formally audited. Please\nuse this software at your own risk.\n\n### Quickstart\n\nTo start an OpenMinter instance on `testnet`, make sure you have [yarn][yarn]\ninstalled (`v1.22.*` or above), and run:\n\n```\nyarn install\nyarn start\n```\n\n## Support\n\nOpenMinter supports the following networks and software components:\n\n#### 🌐 Mainnet and Florencenet\n#### 📦 Sandboxed development via [Flextesa][flextesa]\n#### 🎨 Multimedia NFTs powered by [TZIP-21](https://tzip.tezosagora.org/proposal/tzip-21/)\n#### ⚙️ Smart contracts based on [minter-sdk](https://github.com/tqtezos/minter-sdk)\n#### 👛 Wallets compatible with [Beacon](https://www.walletbeacon.io/)\n#### 📖 Indexing via [tzkt](https://api.tzkt.io/)\n#### 🚀 [IPFS](https://ipfs.io/) via a local node or [Pinata](https://pinata.cloud/)\n#### 🏭 Batch minting support\n\nThe following dependencies are required to run OpenMinter.\n\n| Dependency | Version | Environments\n|-|-|-|\n| [Yarn][yarn] | `v1.22.*` or above | All\n| [Docker][docker] | `v20.10.*` or above | Sandbox\n\n[bcdhub]: https://github.com/baking-bad/bcdhub\n[flextesa]: https://gitlab.com/tezos/flextesa\n[postgres]: https://www.postgresql.org/\n[ipfs]: https://ipfs.io/\n[docker]: https://www.docker.com/get-started\n[yarn]: https://classic.yarnpkg.com/en/docs/install\n\n## Usage\n\n### Configuration\n\nThe Minter can be configured to run on three different networks: `sandbox`,\n`testnet` (currently set to edonet), and `mainnet`.\n\nEach network has its own configuration file in the `config` folder under\n`\u003cnetwork\u003e.json`. The schema of these files can be defined as this TypeScript type:\n\n```typescript\ntype Config = {\n  rpc: string,\n  network: string,\n  bcd: {\n    api: string,\n    gui: string\n  },\n  contracts?: {\n    nftFaucet?: string\n    marketplace?: {\n      fixedPrice: {\n        tez: string;\n      }\n    }\n  }\n}\n```\n\n### Installation\n\nTo install and build the dependences required for local development, run:\n\n```sh\n$ yarn install\n```\n\nThe installation process will fetch toplevel NPM dependences\n\n### Running\n\nTo start OpenMinter on `testnet`, run:\n\n```sh\nyarn start # or yarn start:testnet\n```\n\nTo run OpenMinter configured for `mainnet`, run:\n\n```sh\nyarn start:mainnet\n```\n\n### Bootstrapping Your Own Contracts\n\nOpenMinter ships with a set of contracts on mainnet and testnet that are intended\nonly as a reference implementation and demo. In most cases, you will want to\noriginate your own contracts to run OpenMinter. OpenMinter includes a configuration\nwizard CLI tool to make this process quick and easy.\n\nTo start the configuration wizard, run:\n\n```sh\nyarn bootstrap\n```\n\nOnce the configuration wizard is complete, you can run OpenMinter with your\ncustom config by running:\n\n```sh\nyarn start:custom\n```\n\nAnd to build OpenMinter for a production deployment with your custom config, run:\n\n```sh\nyarn build:custom\n```\n\n## Sandboxed Mode\n\nSandboxed mode is available for OpenMinter for local testing purposes. Make sure\n[Docker][docker] is installed on your system to run the local services.\n\n\u003e **NOTE**: All data in sandboxed mode is ephemeral. Restarts will _not_ persist\n\u003e any blockchain or indexer data.\n\n### Setup and Starting\n\nTo start local sandbox services and create the required default contracts, run:\n\n```sh\nyarn bootstrap:sandbox\n```\n\nFinally, to run the OpenMinter UI, run:\n\n```sh\nyarn start:sandbox\n```\n\n### Stopping\n\nPressing `Ctrl-C` (or `Command-C` on MacOS) after starting the OpenMinter UI\nwill quit the React Scripts process. To teardown the Docker compose system, run:\n\n```sh\nyarn teardown:sandbox\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftqtezos%2Fminter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftqtezos%2Fminter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftqtezos%2Fminter/lists"}