The English readme file in the docs directory was added, and some pro…

…blems in readme-en.md were corrected
dereksx · Oct 30, 2021 · d2b710b · d2b710b
1 parent 49ff8b4
commit d2b710b
Show file tree

Hide file tree

Showing 17 changed files with 161 additions and 16 deletions.
diff --git a/README-en.md b/README-en.md
@@ -151,35 +151,35 @@ Welcome to submit pull request,[Add a new basic task or update the above task](h
   [How to DeFi:Advanced](https://nigdaemon.gitbook.io/how-to-defi-advanced-zhogn-wen-b/)  
 01. [UniswapV2](defi/Uniswap-V2/readme.md) ✅
 02. [UniswapV3](defi/Uniswap-V3/readme.md) ✅
-03. [Compound](defi/Compound/readme.md) [👉 认领这个 Task](https://github.com/rebase-network/Dapp-Learning/issues/new) ⌛
+03. [Compound](defi/Compound/readme.md) [👉 Pick up this task](https://github.com/rebase-network/Dapp-Learning/issues/new) ⌛
 04. [Aave](https://docs.aave.com/portal/)  ⌛
-05. [SNX](https://github.com/Synthetixio) [👉 认领这个 Task](https://github.com/rebase-network/Dapp-Learning/issues/new)
+05. [SNX](https://github.com/Synthetixio) [👉 Pick up this task](https://github.com/rebase-network/Dapp-Learning/issues/new)
 06. [Curve](defi/Curve/README.md) ⌛ 
-07. [0x-protocol](defi/0x-protocal/README.md) [👉 认领这个 Task](https://github.com/rebase-network/Dapp-Learning/issues/new)
-08. [Bancor](https://bancor.network/) [👉 认领这个 Task](https://github.com/rebase-network/Dapp-Learning/issues/new)
-09. [YFI](https://yearn.finance/) [👉 认领这个 Task](https://github.com/rebase-network/Dapp-Learning/issues/new)
-10. [AMPL](https://roninchow.gitbook.io/ampleforth-cn/technology) [👉 认领这个 Task](https://github.com/rebase-network/Dapp-Learning/issues/new)
-11. [Perpetual Protocol](https://www.chainnews.com/articles/163436212237.htm) [👉 认领这个 Task](https://github.com/rebase-network/Dapp-Learning/issues/new)  
-12. [DYDX](https://dydx.exchange/)[👉 认领这个 Task](https://github.com/rebase-network/Dapp-Learning/issues/new)  
+07. [0x-protocol](defi/0x-protocal/README.md) [👉 Pick up this task](https://github.com/rebase-network/Dapp-Learning/issues/new)
+08. [Bancor](https://bancor.network/) [👉 Pick up this task](https://github.com/rebase-network/Dapp-Learning/issues/new)
+09. [YFI](https://yearn.finance/) [👉 Pick up this task](https://github.com/rebase-network/Dapp-Learning/issues/new)
+10. [AMPL](https://roninchow.gitbook.io/ampleforth-cn/technology) [👉 Pick up this task](https://github.com/rebase-network/Dapp-Learning/issues/new)
+11. [Perpetual Protocol](https://www.chainnews.com/articles/163436212237.htm) [👉 Pick up this task](https://github.com/rebase-network/Dapp-Learning/issues/new)  
+12. [DYDX](https://dydx.exchange/)[👉 Pick up this task](https://github.com/rebase-network/Dapp-Learning/issues/new)  
 13. [OPYN](https://v2.opyn.co/)
-14. [INDEX](https://mp.weixin.qq.com/s/PXOY3G6AIbhzRUptjYoWIw)[👉 认领这个 Task](https://github.com/rebase-network/Dapp-Learning/issues/new)
-15. [DODO](https://dodoex.github.io/docs/zh/docs/DODO-Economics-102) [👉 认领这个 Task](https://github.com/rebase-network/Dapp-Learning/issues/new)
+14. [INDEX](https://mp.weixin.qq.com/s/PXOY3G6AIbhzRUptjYoWIw)[👉 Pick up this task](https://github.com/rebase-network/Dapp-Learning/issues/new)
+15. [DODO](https://dodoex.github.io/docs/zh/docs/DODO-Economics-102) [👉 Pick up this task](https://github.com/rebase-network/Dapp-Learning/issues/new)
 16. [MakerDao](https://zhuanlan.zhihu.com/p/41889079)[👉 Claim this task](https://github.com/rebase-network/Dapp-Learning/issues/new)
 17. [Sushi](https://docs.sushi.com/)[👉 Claim this task](https://github.com/rebase-network/Dapp-Learning/issues/new)
 
 ## NFT advanced task
 
-- 01. [OpenSea](nft/opensea/readme.md) [👉 认领这个 Task](https://github.com/rebase-network/Dapp-Learning/issues/new)
-- 02. [aavegotchi](https://aavegotchi.com/) [👉 认领这个 Task](https://github.com/rebase-network/Dapp-Learning/issues/new)
+- 01. [OpenSea](nft/opensea/readme.md) [👉 Pick up this task](https://github.com/rebase-network/Dapp-Learning/issues/new)
+- 02. [aavegotchi](https://aavegotchi.com/) [👉 Pick up this task](https://github.com/rebase-network/Dapp-Learning/issues/new)
 - 03. Loot NFT Distribute 
 
 ## DAO advanced task
 
 - 01. [Aragon](dao/Aragon/readme.md)
-- 02. Augur [👉 认领这个 Task](https://github.com/rebase-network/Dapp-Learning/issues/new)
+- 02. Augur [👉 Pick up this task](https://github.com/rebase-network/Dapp-Learning/issues/new)
 - 03. [DAOHaus](https://daohaus.club/)
-- 04. [DAOstack](https://daostack.io/)  [👉 认领这个 Task](https://github.com/rebase-network/Dapp-Learning/issues/new)
-- 05. [Gnosis](https://github.com/gnosis)[👉 认领这个 Task](https://github.com/rebase-network/Dapp-Learning/issues/new)
+- 04. [DAOstack](https://daostack.io/)  [👉 Pick up this task](https://github.com/rebase-network/Dapp-Learning/issues/new)
+- 05. [Gnosis](https://github.com/gnosis)[👉 Pick up this task](https://github.com/rebase-network/Dapp-Learning/issues/new)
 
 ## Crypto advanced task
 Please read the book first:
@@ -189,7 +189,7 @@ Item list:
 - 02.[PLONK](./crypto/PLONK)
 - 03.[tornado](https://medium.com/taipei-ethereum-meetup/tornado-cash-%E5%AF%A6%E4%BE%8B%E8%A7%A3%E6%9E%90-eb84db35de04)
 - 04.[zk_snark](https://arxiv.org/pdf/1906.07221.pdf)
-[👉 认领这个 Task](https://github.com/rebase-network/Dapp-Learning/issues/new)
+[👉 Pick up this task](https://github.com/rebase-network/Dapp-Learning/issues/new)
 
 ## Smart Contract Security 
 1. Common safety tools

diff --git a/docs/TROUBLE_SHOOTING-en.md b/docs/TROUBLE_SHOOTING-en.md
@@ -0,0 +1,21 @@
+## Common problem
+
+- When installing front-end dependencies, If NPM or YARN is changed to a domestic source, Still a similar ` getaddrinfo ENOENT raw.githubusercontent.com ` error, consider setting up a proxy for it：
+
+    ```shell
+    npm config set proxy http://username:password@server:port
+    npm config set https-proxy http://username:password@server:port
+    ```
+
+    For example：(To set the proxy for YARN, replace the NPM with YARN and the port with the port of the local proxy.)
+
+    ```shell
+    npm config set proxy http://127.0.0.1:2802
+    npm config set https-proxy http://127.0.0.1:2802
+    ```
+
+- **Request for test currency testnet**
+
+- Rinkeby [Apply for Rinkeby test currenc](https://faucet.rinkeby.io/)
+- Kovan [Apply for Kovan test currency1](https://linkfaucet.protofire.io/kovan) [Apply for Kovan test currency2](https://faucet.kovan.network)
+- Ropsten [Apply for Ropsten test currency1](https://faucet.metamask.io/)
diff --git a/docs/TROUBLE_SHOOTING.md b/docs/TROUBLE_SHOOTING.md
@@ -1,3 +1,5 @@
+中文 / [English](https://github.com/rebase-network/Dapp-Learning/blob/main/docs/TROUBLE_SHOOTING-en.md)
+
 ## 常见问题
 
 - 安装前端依赖时，如果在 npm 或者 yarn 修改为国内源之后，依旧出现类似 `getaddrinfo ENOENT raw.githubusercontent.com` 的报错，可以考虑为其设置代理：

diff --git a/docs/basic-knowledge-en.md b/docs/basic-knowledge-en.md
@@ -0,0 +1,11 @@
+## Basic knowledge preparation   
+Read [《Master Ethereum》](https://github.com/inoutcode/ethereum_book)Understand the fundamentals of **Ethereum** and read [Solidity official Document](https://docs.soliditylang.org/) Be familiar with the **Solidity** smart contract language
+
+- Ethereum principle book: <https://ethbook.abyteahead.com/howto.html>
+- Ethereum yellow book: <https://github.com/ethereum/yellowpaper>
+- Ethereum knowledge base: <https://ethfans.org/wikis/Home>
+- Solidity learning: <https://www.bilibili.com/video/BV1St411a7Pk?p=1>
+- Learning while playing Solidity: <https://cryptozombies.io/zh/course>
+- Solidity by Example: <https://solidity-by-example.org/>
+- Solidity ethernaut: <https://ethernaut.openzeppelin.com/>
+- Deep Dive into Rust: <https://itnext.io/deep-dive-into-rust-for-node-js-developers-5faace6dc71f?gi=5c0d5a41e7dd>
diff --git a/docs/basic-knowledge.md b/docs/basic-knowledge.md
@@ -1,3 +1,5 @@
+中文 / [English](https://github.com/rebase-network/Dapp-Learning/blob/main/docs/basic-knowledge-en.md)
+
 ## 基础知识预备   
 阅读[《精通以太坊》](https://github.com/inoutcode/ethereum_book)理解 **以太坊** 的基本原理和 阅读 [Solidity官方文档](https://docs.soliditylang.org/) 熟悉 **Solidity** 智能合约语言
 

diff --git a/docs/books-en.md b/docs/books-en.md
@@ -0,0 +1,5 @@
+## Book recommendation   
+The document contains all kinds of classic books, including but not limited to "humanities", "economics", "social science", etc.
+
+- [《The fiscal code of the central Empire》](https://book.douban.com/subject/27007549/)
+- [《Code punk--Freedom and the future of the Internet》](https://book.douban.com/subject/27054249/)   
diff --git a/docs/books.md b/docs/books.md
@@ -1,3 +1,5 @@
+中文 / [English](https://github.com/rebase-network/Dapp-Learning/blob/main/docs/books-en.md)
+
 ## 书籍推荐   
 文档收录各类经典的书籍, 包括但不限于 "人文"、"经济" 、"社科" 等
 

diff --git a/docs/crypto-course-en.md b/docs/crypto-course-en.md
@@ -0,0 +1,6 @@
+**Ethereum community cryptography course**
+- [Cryptoeconomics - A free, open-source course on the fundamentals of Blockchain protocols](http://cryptoeconomics.study/).
+
+**Domestic blockchain open course**
+- [Xiao Zhen, Peking University： Public class about 《Blockchain technology and application》](https://www.bilibili.com/video/BV1Vt411X7JF)  
+- [Ethereum core technology course](https://study.163.com/course/courseLearn.htm?courseId=1209599851#/learn/video?lessonId=1280010943&courseId=1209599851)  
diff --git a/docs/crypto-course.md b/docs/crypto-course.md
@@ -1,3 +1,5 @@
+中文 / [English](https://github.com/rebase-network/Dapp-Learning/blob/main/docs/crypto-course-en.md)
+
 **以太坊社区加密课程**
 - [Cryptoeconomics - A free, open-source course on the fundamentals of Blockchain protocols](http://cryptoeconomics.study/)
 

diff --git a/docs/dao-en.md b/docs/dao-en.md
@@ -0,0 +1,34 @@
+## How to participate in
+- **Submit a PR or follow account 「Rebase Community」 and contribute a tech share, then add the maintainer WeChat (ID: Yanyanho126) to apply to join the group, or contact Harry directly (WeChat ID: LJYXZJ) to join the developer group**
+- Friends who share in the Rebase community can directly apply to join the group
+- Using the market development method, anyone can submit PR,**Modify only one reference link or document to join the group**, There is no need to complete the task 100% before submitting, Developers work together to help improve the project, You can add links and documentation here[Dapp-Learning-Arsenal](https://github.com/rebase-network/Dapp-Learning-Arsenal)  
+- For each project readme, please be sure to add the directory of reference links and attach the relevant references of the task
+- solidity Version 0.6 or later is recommended
+- The test cases under the script directory can be successfully debugged on the Kovan network (recommended), and the test cases under the test directory can be successfully debugged even on the local node
+**A fledgling project，There are four ways to cut into learning：**
+
+1. You can optimize the previous project code and readme
+2. You can claim the unfinished task card (The links below are all unfinished quest cards, For the completed task card, please put the reference link under the corresponding project readme)
+3. Feel free to add task cards (attach reference link)
+4. Advanced projects (DeFi，DAO，NFT，CRYPTO) can initiate development initiatives in groups and study together in groups
+
+In the developer group, I can have close communication with developers and participate in the Dapp research group to study DEFI, DAO, and other projects together.
+
+## Group learning
+  Advanced tasks, such as DeFi, Dao, and NFT project research, adopt group learning mode and have the following requirements.
+ 1. Developers who submit more than one PR can participate in the group study;
+ 2. In principle, the subtask research of the team shall not exceed 3 people, and the team members shall have a clear division of labor and supervise each other;
+ 3. Front end and graph are optional, White papers and smart contracts are mandatory;
+ 4. In principle, it needs to be shared once a week, which can be postponed once.
+
+ Study in groups and show results (reference)：    
+ White paper/contract/front-end/GRAPH: Deployment, documentation and Rebase video sharing
+
+
+## The DAO organization manages the project
+  1. If you have participated in PR(or tech sharing) once or more, you can join the developer group;
+  2. After submitting 3 copies of high-quality PR (or participating in 3 tasks), you can join the PR audit team and or obtain the authority to audit PR
+  3. PR reviewers can initiate study groups;
+  4. The PR reviewer can initiate a proposal, decide the project development plan, and obtain the consent of most PR reviewers to pass the proposal;
+  5. A PR reviewer must do a PR at least once within two weeks, otherwise remove the PR reviewer permission, demote to the normal developer, and re-join with PR;
+  6. In principle, weekly developer networking meetings.
diff --git a/docs/dao.md b/docs/dao.md
@@ -1,3 +1,5 @@
+中文 / [English](https://github.com/rebase-network/Dapp-Learning/blob/main/docs/dao-en.md)
+
 ## 如何参与
 - 提交一次PR 或 关注公众号 「Rebase社区」并贡献一次技术分享，然后添加Maintainer微信yanyanho126申请入群,或直接联系Harry(微信号:ljyxxzj)进开发者群
 - 已在Rebase社区分享过的小伙伴可以直接申请入群

diff --git a/docs/dapp-demo-en.md b/docs/dapp-demo-en.md
@@ -0,0 +1,11 @@
+## Expected practical demonstration project:  
+| Project |    Point person |
+| :----:|  :----: |
+| dydx | yan |
+| perpetual | yan |
+| opyn |  |
+| euler |  |
+| volmex |  |
+| visor |  |
+
+
diff --git a/docs/dapp-demo.md b/docs/dapp-demo.md
@@ -1,3 +1,5 @@
+中文 / [English](https://github.com/rebase-network/Dapp-Learning/blob/main/docs/dapp-demo-en.md)
+
 ## 期望实操演示项目:  
 | 项目 |    认领人 |
 | :----:|  :----: |

diff --git a/docs/develop-tools-en.md b/docs/develop-tools-en.md
@@ -0,0 +1,16 @@
+## Development Tool Recommendation    
+- Ethereum Development Tools Collection: <https://learnblockchain.cn/article/2006>
+- metamask (Wallet plug-in for browser): <https://www.jianshu.com/p/b5b2c05e9090>
+- infura (node service): <https://infura.io/>
+- alchemy (node service): <https://dashboard.alchemyapi.io/>
+- Ethernet node service list：<https://ethereumnodes.com/>
+- All tests are connected to the Kovan test network，Kovan tests ETH application: <https://faucet.kovan.network>, other test networks are also freely available.
+- Ethereum blockchain browser: <https://kovan.etherscan.io>
+- JSON-PRC's interface: <https://eth.wiki/json-rpc/API>
+- tenderly Contract verification: <https://dashboard.tenderly.co/explorer>
+- remix Local environment: <https://zhuanlan.zhihu.com/p/38309494>
+- Code beautification tool: <https://www.cnblogs.com/kuronekonano/p/11794302.html>
+- Ethernet compatible chain network list(Easy to add to Metamask)：<https://chainlist.org/>
+- Layer2Ecological project development status tracking：<https://l2beat.com/>
+- Ethernet Virtual Machine Instruction Manual:<https://ethervm.io/>
+
diff --git a/docs/develop-tools.md b/docs/develop-tools.md
@@ -1,3 +1,5 @@
+中文 / [English](https://github.com/rebase-network/Dapp-Learning/blob/main/docs/develop-tools-en.md)
+
 ## 开发工具推荐    
 - 以太坊开发工具汇总: <https://learnblockchain.cn/article/2006>
 - metamask（浏览器钱包插件）: <https://www.jianshu.com/p/b5b2c05e9090>

diff --git a/docs/relative-projects-en.md b/docs/relative-projects-en.md
@@ -0,0 +1,25 @@
+## Derivative project
+- [Dapp-Learning-Arsenal](https://github.com/rebase-network/Dapp-Learning-Arsenal): Project Arsenal, Good links, documents, PDF, XMIND large files can be put in this project, Newcomers don't know where to put the link in the DAPP learning project, you can also put this project directly, there are small partners to collect in the follow-up
+- [Dapp-Learning-Sourcecred](https://github.com/rebase-network/Dapp-Learning-Sourcecred): Project contribution list, Recording developer contributions, as well as distributing rewards, is one of the DAO governance project tools
+- [Dapp-Learning-MOH](https://github.com/rebase-network/Dapp-Learning-MOH): Project Medal of Honor，each participant was given an NFT souvenir.
+
+## Maintenance items together
+
+- [amm-arbitrageur](https://github.com/paco0x/amm-arbitrageur): AMM Example arbitrage Strategy
+
+
+## Contract reference library and pay tribute to related projects
+
+- Classic contract Library - <https://github.com/OpenZeppelin/openzeppelin-contracts>
+- Contract safe library - <https://github.com/ConsenSys/smart-contract-best-practices>
+- Dapp Scaffolding - <https://github.com/austintgriffith/scaffold-eth>
+- Contract tutorial - <https://github.com/HQ20/contracts>
+- Blockchain Tutorial - <https://learnblockchain.cn/>
+- Cryptography course - <https://live.csdn.net/list/Kevin_M_00>
+- DeFi course - <https://github.com/OffcierCia/DeFi-Developer-Road-Map>
+- Solidity Getting Started tutorial - <https://github.com/liushooter/learn-blockchain/tree/master/learning-solidity-2018>
+- Awesome Solidity - <https://github.com/bkrem/awesome-solidity>
+- Solidity Learning - <https://github.com/willitscale/learning-solidity>
+
+## List of hands-on demonstration projects
+  The development group regularly shares the practical demonstration of classic projects, Welcome to join the project you want to practice, Please refer to [documentation](./docs/dapp-demo.md)
diff --git a/docs/relative-projects.md b/docs/relative-projects.md
@@ -1,3 +1,5 @@
+中文 / [English](https://github.com/rebase-network/Dapp-Learning/blob/main/docs/relative-projects-en.md)
+
 ## 衍生项目
 - [Dapp-Learning-Arsenal](https://github.com/rebase-network/Dapp-Learning-Arsenal): 项目军火库，不错的链接，文档，pdf，xmind大文件都可以放在此项目，新人不知道放链接到Dapp-Learning哪里，也可以直接放此项目，后续有小伙伴收录进Dapp-Learning。
 - [Dapp-Learning-Sourcecred](https://github.com/rebase-network/Dapp-Learning-Sourcecred): 项目贡献榜，记录开发者贡献值，以及分发奖励，dao治理项目的工具之一。