jeffemmett
/
non-fungible-apps
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update readme, add serverless section. (#237)

This commit is contained in:
Shredder 2023-05-02 13:38:12 +03:30 committed by GitHub
parent a20ec8bb22
commit 69ebd36a5b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -1,6 +1,6 @@
# Fleek Non Fungible Apps
# Fleek Non-Fungible Apps
**The repository for Fleek Non Fungible Apps project**
**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.
@ -21,44 +21,48 @@ You can find the wiki [here](https://github.com/fleekxyz/non-fungible-apps/wiki)
### 📁 Project Structure
Inside the root folder you are going to find:
- [contracts](./contracts): all the developed contracts
- [contracts](./contracts): All the developed contracts
- [subgraph](./subgraph): The Graph project related code
- [ui](./ui): a web application to interact with deployed contracts
- [serverless](./serverless): The serverless and Mongo/Prisma set-up
- [ui](./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](./contracts/README.md) for more info.
### 🖥️ User Interface
Within the project is included a [React](https://reactjs.org/) web application to expose and test the interaction with deployed scripts. Check the [UI readme](./ui/README.md) for more info.
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](./contracts/README.md) 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](./subgraph/README.md) for more info.
To index data off-chain, we use TheGraph and this section is the code required for our subgraph. Check the [subgraph readme](./subgraph/README.md) for more info.
### Serverless
For verification purposes and our off-chain stack, we are using a MongoDB instance integrated with Prisma and serverless handlers. Check the [serverless readme](./serverless/README.md) for more info.
### User Interface (UI)
Within the project is included a [React](https://reactjs.org/) web application to expose and test the interaction with deployed scripts. Check the [UI readme](./ui/README.md) for more info.
### 💅 Code Styling
For code formatting we are using [Prettier](https://prettier.io/) and following the [styling guide from Solidity documentation](https://docs.soliditylang.org/en/v0.8.16/style-guide.html). For formatting the code you are able to run:
For code formatting, we are using [Prettier](https://prettier.io/) and following the [styling guide from Solidity documentation](https://docs.soliditylang.org/en/v0.8.16/style-guide.html). For formatting the code you can run:
```
$ yarn format
```
> ⚠️ Please make sure you are following the code styling guid before pushing code
> ⚠️ Please make sure you are following the code styling guide before pushing the 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:
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 applications. 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
- Prove how the concept would be applied 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.
Later on, when the initiative proves its value, a service will be added to Fleek's platform in a friendly way for anyone to be able to get their applications onboard.
## 💡 Proof of concept
@ -66,7 +70,7 @@ The proof of concept was concluded last year and you can reach more information
## 📚 Dependency Highlights
We use the following libraries to develop Fleek Non Fungible Apps
We use the following libraries to develop Fleek Non-Fungible Apps
- [Eslint](https://eslint.org/) + [Prettier](https://prettier.io/)
- [Ethers](https://docs.ethers.io/v5/)
@ -79,11 +83,11 @@ 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](/CONTRIBUTING.md).
This is an open-source initiative! Any new idea is welcome, if you want to help us to improve the project please check out [the contributing guide](/CONTRIBUTING.md).
## 📜 License
Fleek Non Fungible Apps is released under the [MIT License](LICENSE).
Fleek Non-Fungible Apps is released under the [MIT License](LICENSE).
## 🐛 Bug reporting