Skip to content

OxMarco/TheSecretPassage

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Logo

TheSecretPassage.

A simple and decentralised NFT platform built on top of Zilliqa

View Demo · Report Bug · Request Feature

cover

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

NFTs are one of the key innovating technologies of the recent years with a massive potential to disrupt the art and multimedia industry. While the technical framework is already there, what is left for mass adoption is to create intuitive systems to make people want to use NFTs. That is the rationale behind TheSecretPassage, a NFT showcase gallery with a personal dashboard and an integrated minting platform. The curated UI is the key enabler for a larger adoption of NFTs in the art world, together with a direct interaction with social media providers and the humanisation of profiles (a nickname and an avatar communicate way more than a wallet address).

Main features

  • IPFS-powered metadata
  • user accounts with image and nickname
  • nfts sorted by category
  • modular architecture
  • users own their data and can delete it at any times

Technical Info

On the homepage new users will be presented with a (skippable) registration form where they can set a username and an avatar image that best represents them. The two info will be combined in a JSON and uploaded to IPFS, while the key pair address and metadataCID will be saved on the smart contract. By now, all NFTs minted by that user will present the nickname instead of a wallet address. TheSecretPassage users are also shown in a slideshow at the bottom of the homepage, to promote a sense of community.

On the info page users can add a rating to the NFT from 1 to 5 stars and share the artwork on social media, namely Facebook and Reddit. If the user is the owner of the NFT, they will also be displayed a button to delete (burn) it.

Going to the dashboard, users will have all their NFTs listed and a button to remove their account. Removing their account doesn't delete the NFTs, they will still have to remove them one by one. That is to prevent accidental deletion.

Finally, on the mint page users will be asked to confirm their address as a minter and will be able to mint new NFTs in a codeless way.

Future Ideas

Surely an integral part of the next development phase will be to further debug the dapp and to include more social integrations like whole portfolio share as well as a bridge for Ethereum-native NFTs.

Getting Started

Deploy a local copy of the project and test it yourself.

Prerequisites

To setup the development environment, run the following commands:

  • npm

    npm install --global npm@latest
  • yarn

    npm install --global yarn@latest

You will also need to have some test tokens in your personal wallet and to have installed ZilPay wallet on testnet.

Installation

To install the repository and run it locally:

  1. Clone the repo
    git clone https://github.com/grcasanova/TheSecretPassage.git
  2. Install nodejs packages with yarn
    yarn install
  3. Start the app with
    yarn start

Usage

Using TheSecretPassage is very simple, just head off the Homepage and login with your ZilPay wallet, register your username, go to the mint page and confirm your addition to the minters and you're good to go!

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request and describe your proposal

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Web Link: Homepage

Authors

Acknowledgements