Developers who are new to Flow and are looking for a hands-on approach to learning Cadence via smart contract examples that follow a logical, journey-based structure.
Blockchain developers already familiar with basic Cadence but are looking for examples of functionality and features unique to Flow.
Evidence for the need:
The current state of the Cadence Cookbook is in need of a refresh; this includes the UI, information architecture, and content presented on the site
Proposed solution
The goal of this grant is to reach a functional state for the new Cadence Cookbook MVP, merge latest changes into the cadence-cookbook repo, and release live to users using existing content on the site. On completion of this grant, the cadence-cookbook repo and website would be in a functional state; further improvements and new features can then be incrementally released as part of subsequent grants, including: updating existing recipes, adding components such as FAQs/progression bar between recipes, writing test cases for recipes, thorough testing suite on front-end code and sub-repos, better code snippet UX, improved integrations with Playground/kapa.ai, adding new recipes, etc.
Impact
In what ways does this benefit the broader Flow developer ecosystem?
By adding relevant examples and pertinent smart contract use-cases to the site, the Cadence Cookbook can serve as an authority/knowledge base for Cadence developers and those new to Flow. Many blockchain applications require similar smart contract paradigms; these can be templatized as code examples within the Cookbook and serve as a useful point of reference for developers, featuring high quality code examples and robust testing of the smart contract. Additionally, examples featured in the Cookbook can highlight the unique capabilities of Cadence/Flow and encourage new developers to join the ecosystem.
Milestones and funding
Milestone
Deliverables
Timeline
Risks
USD proposal
Corresponding Github issues
1 - Onboard content currently in the live Cookbook
This would involve creating a repo for each recipe, moving code out to Cadence files/text out to txt files, and creating a reference to recipe submodule in the parent repo. Assigning parent modules, labels/categories to onboarded. Assigning a chronological ordering to recipes. Total 22 recipes (excluding 2 KittyItems recipes which will be removed from new Cookbook).
Complete functionality from the skeleton MVP: filtering of recipes, searching recipes, overall layout of recipes on homepage and hero navigation implemented by user journey, fully dynamic recipe page with conditional rendering of components. Updated UI styling to reflect Flow brand guidelines. Linting and documentation of code.
Setup testing infrastructure for front-end repo using Cypress (end to end testing) and Jest (unit tests). Set up MVP of running Cadence tests in a sub-repo from parent repo. Configured Github action(s) in the parent repo to trigger test run.
Updated documentation for new process of contributing to the Cookbook (how contribution repo and PR should be formatted, what fields are supported). Deliverable will include MD write up in main repo and walkthrough video tutorial showing the process.
Completed SEO in Next.js for recipe pages and homepage now that all site pages are static URLS; title, meta, keywords, OpenGraph and Google Schema, sitemap, etc.
Updated deployment/build scripts for new codebase. Create Github actions for deployment, integrate with MVP Github action(s) for running tests (milestone 3) to run tests before the build. Merge new front-end code into master branch of current cadence-cookbook repo. Deploy to existing environment (unknown?). Transfer ownership of recipe sub-repos to Flow.
1 week
Current deployment setup for the cadence-cookbook repo is unknown.
Cadence Cookbook Updates 2 - MVP Delivery
Grant category
Please select one:
Description
This grant proposal is an extension of work completed as part of Cadence Cookbook Updates.
Problem statement
Target audience:
Evidence for the need:
Proposed solution
The goal of this grant is to reach a functional state for the new Cadence Cookbook MVP, merge latest changes into the cadence-cookbook repo, and release live to users using existing content on the site. On completion of this grant, the cadence-cookbook repo and website would be in a functional state; further improvements and new features can then be incrementally released as part of subsequent grants, including: updating existing recipes, adding components such as FAQs/progression bar between recipes, writing test cases for recipes, thorough testing suite on front-end code and sub-repos, better code snippet UX, improved integrations with Playground/kapa.ai, adding new recipes, etc.
Impact
By adding relevant examples and pertinent smart contract use-cases to the site, the Cadence Cookbook can serve as an authority/knowledge base for Cadence developers and those new to Flow. Many blockchain applications require similar smart contract paradigms; these can be templatized as code examples within the Cookbook and serve as a useful point of reference for developers, featuring high quality code examples and robust testing of the smart contract. Additionally, examples featured in the Cookbook can highlight the unique capabilities of Cadence/Flow and encourage new developers to join the ecosystem.
Milestones and funding
Total funding proposed: 8400
Team