18d3319fd7
* chore: rearrange hardhat tests folder structure * chore: add FleekERC721 hardhat test helpers * test: split out deployment tests * test: split out minting tests * test: split out token uri tests * test: split out token roles tests * test: split out collection roles tests * test: split out access points tests * test: split out update properties tests * test: improve test setup for aps and deployment * test: move test resultant base64 logos to constants file |
||
|---|---|---|
| .github/workflows | ||
| .husky | ||
| contracts | ||
| subgraph | ||
| ui | ||
| .gitignore | ||
| .gitmodules | ||
| .prettierignore | ||
| .prettierrc | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| README.md | ||
| package.json | ||
| yarn.lock | ||
README.md
Fleek Non Fungible Apps
The repository for Fleek Non Fungible Apps project
🚧 IMPORTANT 🚧 - This initiative is under development, so this repo should be treated as a WIP. The goals and the roadmap might change as the project is shaped.
⚡ Overview
This is the landing point for Fleek's initiative to implement infrastructure as Solidity contracts.
The vision is to have this on a suitable L2 or L3 based on EVM so there is flexibility in terms of which chains to work with. And we can create a network of smart contracts that represent the different parts of your stack.
The goal is to be a more verifiable and crypto-friendly Serverless.yaml or Cloudformation manifests that will enable us to develop use cases on top like community hosting.
We've developed a base set of contract code so now we want to harden it as well as add more metadata and features to support use cases with the first use case being community hosting. So be sure to check out the roadmap on the wiki.
You can find the wiki here for more information about the project.
⌨️ Developing
📁 Project Structure
Inside the root folder you are going to find:
- contracts: all the developed contracts
- subgraph: The Graph project related code
- ui: a web application to interact with deployed contracts
You can see breakdowns of other folders in the README within those folders.
Contracts
Within the project is the contracts folder which houses the contracts, utils, tests and deployment scripts associated with the Solidity smart contracts. Check the contracts readme for more info.
🖥️ User Interface
Within the project is included a React web application to expose and test the interaction with deployed scripts. Check the UI readme for more info.
Subgraph
In order to index data offchain, we use TheGraph and this section is the code required for our subgraph. Check the subgraph readme for more info.
💅 Code Styling
For code formatting we are using Prettier and following the styling guide from Solidity documentation. For formatting the code you are able to run:
$ yarn format
⚠️ Please make sure you are following the code styling guid before pushing code
🛣️ Roadmap
Our goal is to reach a point where trustable Solidity contracts can be used for identifying properly the data about web3 applications. Within that goal, we want to also provide ways for users to organize and list information about their application. To get at this we are currently starting with:
- Define trustable and extendable smart contracts and standards
- Prove how the concept would be applicable using static sites
- Prove community hosted apps via these contracts
Later on, when the initiative prove its value, a service will be added to Fleek's platform in a friendly way for anyone be able to get their applications onboard.
💡 Proof of concept
The proof of concept was concluded last year and you can reach more information here.
📚 Dependency Highlights
We use the following libraries to develop Fleek Non Fungible Apps
🙏 Contributing
This is an open source initiative! Any new idea is welcome, if you want to help us to improve the project please checkout the contributing guide.
📜 License
Fleek Non Fungible Apps is released under the MIT License.
🐛 Bug reporting
If you have found a bug to report, please create an issue. Thank you!