joseph-hurtado/ic-nft-marketplace

Jelly - NFT Marketplace Infrastructure & BE Toolkit

🍭 Jelly - An NFT Marketplace & Toolkit

The NFT Marketplace is the backend Service for our DIP-721 implementation, and soon a multi-standard NFT Marketplace.

🚧 IMPORTANT 🚧 - Jelly is currently in it's first version of development as we move towards a full marketplace protocol. This repo should be treated and such and is subject to change.

📒 Table of Contents

• Service Flow Docs
• Requirements
• Getting started
• Integrations
  • Tools
  • Create non-fungible tokens mock
• Contribution guideline

⚙️ Requirements

TLDR; We're providing implementation examples and related test or use-cases for your convinence, if you are just interested in the specifications find it here.

The requirements listed here are for running the DIP-721 example implementations that are available in this repository. If you are just interested in the specification for DIP-721 follow the link here.

• Nodejs
• Yarn or NPM
• The DFX SDK to run the CLI

💡 During the guide we'll be using yarn, but this can be easily replaced by npm, if that's your preference.

🤔 Getting started

We'll use Nodejs package.json to provide and describe convenient methods to bootstrap, build or reset the state of the provided test cases.

Jelly interacts with Cap, Dab, Crowns (a DIP-721 token) and wICP (a DIP-20 token). If you haven't learn about these, learn more about them by clicking in the available links!

Jelly runs against these Service canisters, on mainnet and also within the local replica network when developing; As such these should be available in the network. For example, for local replica network, if you're already running the Service separatily on your own, feel free to skip the steps to initialise all the dependencies mentioned below. Otherwise, you have to pull and initialise the Git repositories far all the required Services as follows:

yarn services:init

You only need to do it once, for example, after you cloned the Marketplace Services repository.

Note: Make sure you have the DFX SDK installed to run the DFX cli, otherwise visit the Dfinity for instructions

Launch the local replica in the foreground (you're advised to do it, to monitor the service, otherwise feel free to add the --background flag). You can open a new shell session afterwards while monitoring the local replica network.

dfx start --clean

Running the Service dependencies

The following assumes that the local replica network is available and running. It's recommended to run the reset command everytime you need to initialse it.

yarn reset

💡 If you don't know how to start a local replica check the getting started, or the documentations in the Dfinity docs for more details.

😅 TLDR; Run all the required services by executing the services:start command.

yarn services:start

Bare in mind that you'll have to deploy the DIP-721, set allowances, etc on your own, depending on your use-case.

The 🚑 Healtcheck provides a description of how this can look like for the use-case where a DIP-721 is listed for sale, a user gets a sale offer and accepts it.

yarn marketplace:healthcheck

💡 If you'd like to know which services and how they are initialised then check the Service dependencies document, as this might be useful for troubleshooting.

🙏 Contributing

Create branches from the main branch and name it in accordance to conventional commits here, or follow the examples bellow:

test: 💍 Adding missing tests
feat: 🎸 A new feature
fix: 🐛 A bug fix
chore: 🤖 Build process or auxiliary tool changes
docs: ✏️ Documentation only changes
refactor: 💡 A code change that neither fixes a bug or adds a feature
style: 💄 Markup, white-space, formatting, missing semi-colons...

Find more about contributing here, please!