jfrazier-eth / marketplace

An open source NFT marketplace built on Reservoir.

Reservoir Market

An open source NFT marketplace built on Reservoir.

About The Project

Reservoir Market is an open source marketplace that enables communities to easily launch their own NFT marketplace, accessing instant liquidity aggregated from other major marketplaces.

The marketplace supports 3 different modes:

• Single collection (e.g. Crypto Coven)
• Multi collection community (e.g. BAYC)
• All collections (example)

With each deployment, communities are given full control over their marketplace from designing their look and feel to setting their own marketplace fees.

(back to top)

Getting Started (Self-Hosted)

Prerequisites

1. Install Node.js and NPM
2. Install Yarn
3. Request free Reservoir API key

Built With

• ReservoirKit
• Reservoir Protocol and API
• Next.js
• React.js
• Ethers.io
• WAGMI
• Tailwind CSS

Installation

Fork this repo and follow these instructions to install dependancies.

With yarn:

$ yarn install

With NPM:

$ npm install

Configuration

Reservoir Market is built to be fully configurable using environment variables. To preview your configuration locally you can copy the values you want to use from env.development or env.production into a new file called .env.local.

Note: Environment variables can also be added during deployment via deployment platforms like vercel.

Required Environment Variables

Environment Variable	Required	Description	Example
NEXT_PUBLIC_RESERVOIR_API_BASE	true	The Reservoir API base URL. Available on Mainnet, Rinkeby, Goerli, and Optimism.	https://api-rinkeby.reservoir.tools/ https://api.reservoir.tools/
NEXT_PUBLIC_CHAIN_ID	true	The Ethereum network to be used. 1 for Etherem Mainnet and 4 for Rinkeby Testnet, etc.	1 4
NEXT_PUBLIC_PROXY_API_BASE	true	The proxy API used to pass the Reservoir API key without exposing it to the client.	/api/reservoir
NEXT_PUBLIC_RESERVOIR_API_KEY	true	Reservoir API key provided by the Reservoir Protocol. Get your own API key.	123e4567-e89b-12d3-a456-426614174000
NEXT_PUBLIC_ALCHEMY_ID	true	Alchemy API key required for buying items on mobile. Get your own API key here.	123e4567-e89b-12d3-a456-426614174000

Please visit our docs to view all supported environment variables.

Run the App

Once you have your setup ready, run:

With yarn:

$ yarn dev

With npm:

$ npm run dev

Deploy with Vercel

This is a Next.js app that can be easily deployed using Vercel. For more information on how to deploy your Github repository with Vercel visit their docs.

(back to top)

Contributing

If you'd like to contribute please follow the guidelines.

Contact

Twitter: @reservoir0x Discord: Reservoir Protocol Project Link: Reservoir Protocol

(back to top)