nft-folder-blockchain-connector v1.0.1
📚 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
Utility for linting and enforcing code quality in JavaScript and TypeScript
Library for interacting with Ethereum and blockchain networks
Powerful JavaScript testing framework
Node.js framework for building scalable server-side applications
JavaScript runtime built on Chrome's V8 engine for scalable applications
Code formatter for consistent style
Tools for designing and documenting APIs
Strongly typed programming language that enhances JavaScript
🚀 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.
🤝 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".
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/amazing-feature) - Commit your Changes (
git commit -m 'feat: add some amazing-feature') - Push to the Branch (
git push origin feature/amazing-feature) - Open a Pull Request
We are using Conventional Commits for our commit messages.
🏆 Top Contributors
📜 License
Licensed under the Apache License 2.0. See LICENSE for details.
📬 Contact
Lukas Grieger: lukas.grieger@iml.fraunhofer.de
Michael Pichura: michael.pichura@iml.fraunhofer.de
🙏 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