Skip to content

Latest commit

 

History

History
242 lines (172 loc) · 7.61 KB

README.md

File metadata and controls

242 lines (172 loc) · 7.61 KB

Contributors Forks Stargazers Issues MIT License


Logo

Digital Assets Tag

Digitizing physical assets using NFT and RFID tag
Explore the docs »

View Demo · Report Bug · Request Feature

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

About The Project

Context

Consumers currently receive a physical receipt when they purchase goods like apparel. These are not environmentally sustainable and can be challenging to manage. 

Most receipts are composed of both paper and plastic. The materials are not recyclable because it is impossible to separate them.

To make matters worse, receipts can be forged easily through free websites. Digital receipts are even easier to forge.

DAT

DAT (Digital Assets Tag) helps consumers who want to reduce environmental waste and fraud by providing a NFT receipt that replaces paper-based receipts completely and enables receipts to be more unique unlike current physical and digital receipts.

Product Name Screen Shot

(back to top)

Built With

  • Next
  • React
  • Arduino

(back to top)

Getting Started

DAT architecture includes 2 main components - a frontend App and an Arduino-based RFID reader

Prerequisites

Frontend App Installation

  1. Clone the repo

    git clone https://github.com/Niceural/dat.git
  2. Navigate to frontend/

    cd ./frontend
  3. Install frontend dependencies

    yarn

    or

    yarn install
  4. Setup environment variable by creating .env.local

    Copy example file

    cp ./.env.example ./.env.local

    Update environment variables in .env.local

    NEXT_PUBLIC_CONTRACT_ADDRESS=<YOUR_CONTRACT_ADDRESS>
    # ...
  5. Run Next.js dev server

    yarn dev

Arduino Environment Setup

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Build store staff management view
  • Build mobile app for easier transferring tokens

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

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

(back to top)

License

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

(back to top)

Contact

Project Link: https://github.com/Niceural/dat

(back to top)