One of the other NCD submission criteria is that the demo repository must include sufficient documentation to stand up your project after cloning locally. Also the repository must include some kind of explanation or overview of the intent of your project. You can check some examples below. The main reason for explanation is that person who analyzes your repo needs to understand your project. Keep this in mind when preparing the documentation. 

  • What is this project about (explain your project in one paragraph)
  • Tell us how to clone and build your project
  • Explain each function that your contract has and show us how to run them
  • Also, show us how to use your scripts


This is a nice example of what it should look like:

https://github.com/aimensahnoun/Near-Dice-Demo


https://github.com/Learn-NEAR/NCD.L1.sample--thanks

https://github.com/Learn-NEAR/NCD.L1.sample--lottery

https://github.com/Learn-NEAR/NCD.L1.sample--nearly-neighbors

https://github.com/Learn-NEAR/NCD.L1.sample--meme-museum


Lesson discussion

Swap insights and ask questions about NEAR Developer Course

Be the first to start the discussion

Ask a question or share your thoughts about this lesson.