🏭 Open Format factory starter

A basic factory starter template.

Getting Started

These instructions will give you a copy of the project up and running on your local machine for development and testing purposes.

Installation

Install JavaScript dependencies

yarn install OR npm install

Setup your environment variables

cp .env.local.example .env.local

Environment variable configuration

Variable	Description
NEXT_PUBLIC_CHAIN_ID	This is the chain id of the network you want to connect to. Open Format currently supports Polygon Mainnet (137) and Polygon Mumbai (80001)
NEXT_PUBLIC_NFT_STORAGE_TOKEN	This starter uses nft.storage to interact with IPFS. You can use any IPFS storage provider. Get an API Key
NEXT_PUBLIC_FACTORY_ID	This is used for filtering the subgraph to only show tokens created in specific factory frontend. This can be any string value, but for uniqueness, we recommend using UUIDv4

Development

Running

yarn run dev

This will run the app in the development mode. Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits. You will also see any lint errors in the console.

Documentation and Support

Open Format Documentation

Have a question? Join us on Discord

Learn More

This project was created using NextJS.

Find out more about the packages used in this project:

• ethers
• TailwindCSS
• OnboardJS
• nft.storage