nft-folder-blockchain-connector
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

Stars Forks Watchers Contributors Commit Activity Last Commit Issues License


Blockchain Connector (NFT-Folder)

A NestJS-based blockchain connector for interacting with specific smart contracts from the NFT-Folder project.
🐞 Report Bug · 💡 Request Feature

Table of Contents
  1. 📚 About The Project
  2. 🚀 Getting Started
  3. 🤝 Contributing
  4. 📜 License
  5. 📬 Contact
  6. 🙏 Acknowledgments

📚 About The Project

📄 Description

The NFT-Folder project enables the tokenization, structuring and secure storage of assets as Non-Fungible Tokens (NFTs) on the blockchain. With tamper-proof and traceable documentation of changes, NFT-Folder ensures the integrity and authenticity of digital assets, making it a valuable tool for various industries. Key components include:

  • Blockchain Connector: A NestJS bridge for enabling interactions between an application and the smart contracts.
  • Container Smart Contract: Organizes and manages NFTs for each organization.
  • Segment Smart Contract: Enables the subdivision of NFTs into logical segments within a container.
  • Token Smart Contract: Follows the ERC-721 standard for NFTs on Ethereum, allowing for industrial tokenization of assets by storing additional essential information, such as identifiers and fingerprints.

📖 Documentation

A detailed documentation for the NFT-Folder project is available in this repository.

🛠️ Built With

  • ESLint Utility for linting and enforcing code quality in JavaScript and TypeScript
  • Ethers Library for interacting with Ethereum and blockchain networks
  • Jest Powerful JavaScript testing framework
  • NestJS Node.js framework for building scalable server-side applications
  • Node.js JavaScript runtime built on Chrome's V8 engine for scalable applications
  • Prettier Code formatter for consistent style
  • Swagger Tools for designing and documenting APIs
  • TypeScript Strongly typed programming language that enhances JavaScript

(back to top)

🚀 Getting Started

To set up and run the NFT-Folder locally, please consult the Tutorial section in our documentation. This section provides step-by-step instructions to guide you through the process of installing, configuring and running the NFT-Folder environment on your local machine.

(back to top)

🤝 Contributing

🌟 Getting Involved

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".

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/amazing-feature)
  3. Commit your Changes (git commit -m 'feat: add some amazing-feature')
  4. Push to the Branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

We are using Conventional Commits for our commit messages.

🏆 Top Contributors

contrib.rocks image

(back to top)

📜 License

Licensed under the Apache License 2.0. See LICENSE for details.

(back to top)

📬 Contact

Lukas Grieger: lukas.grieger@iml.fraunhofer.de

Michael Pichura: michael.pichura@iml.fraunhofer.de

(back to top)

🙏 Acknowledgments

  • Best-README-Template provided inspiration and structure for creating this README file
  • Img Shields enabled the creation of customizable and visually appealing badges for this project
  • contrib.rocks simplified the visualization of contributors in this project

(back to top)

Package Sidebar

Install

npm i nft-folder-blockchain-connector

Weekly Downloads

3

Version

1.0.1

License

Apache-2.0

Unpacked Size

408 kB

Total Files

124

Last publish

Collaborators

  • mipicdev