Embeddable code playground and runner for interactive Cardano documentation that supports multiple programming languages (Aiken, Opshin, Python, Javascript…)
Problem
Due to the lack of an embedded code playground and runner, most Cardano documentation and training materials are less intuitive, take time, and don't have interactive experiences for learners.
Total to date
This is the total amount allocated to Embeddable code playground and runner for interactive Cardano documentation that supports multiple programming languages (Aiken, Opshin, Python, Javascript…).
About this idea
[GENERAL] Name and surname of main applicant
Tim Ng[GENERAL] Are you delivering this project as an individual or as an entity (whether formally incorporated or not)
Individual[GENERAL] Co-proposers and additional applicants
Phong Phu Tran
[GENERAL] Please specify how many months you expect your project to last (from 2-12 months)
9[GENERAL] Please indicate if your proposal has been auto-translated into English from another language
No[GENERAL] Summarize your solution to the problem (200-character limit including spaces)
We will provide a code playground and runner that can easily embedded in any website for better Cardano documentation, allowing learners to view, edit & run sample codes directly in the materials.
[GENERAL] Does your project have any dependencies on other organizations, technical or otherwise?
No[GENERAL] If YES, please describe what the dependency is and why you believe it is essential for your project’s delivery. If NO, please write “No dependencies.”
No dependencies
[GENERAL] Will your project’s output/s be fully open source?
Yes[GENERAL] Please provide here more information on the open source status of your project outputs
The entire project will be fully open-source, encouraging community contributions and future development.
[METADATA] Horizons
Developer Tools[SOLUTION] Please describe your proposed solution
We will provide a code playground and runner that can easily embedded in any website for better Cardano documentation, allowing learners to view, edit & run sample codes directly in the materials.
The playground can be used as a standalone in a dedicated website that allows users to write, save, and share their code snippets for multiple purposes. They can also run and test the codes directly on the website, without installing other tools.
The code playground can also be embedded in any other websites to make their code training content intuitive and interactive instantly. Learners can try to edit, run, and even test the code directly while reading the materials, which gives great learning experiences.
The playground will support most programming languages needed for Cardano developers, like Aiken, Python, Opshin, Javascript, Typescript.
[IMPACT] Please define the positive impact your project will have on the wider Cardano community
Our embeddable code playground and runner for interactive Cardano documentation will help the Cardano community in many ways:
- Allows Cardano Developers to write, save and share code snippets quickly for multiple purposes.
- Allows developers and educators to save a lot of time while writing technical documentation with code demonstration, with embedded beautifully formatted and runnable code
- Allow learners to have better experiences and effectiveness while reading the materials and learning about Cardano development.
Measuring Success
We'll track key metrics to gauge impact:
- Key analytics of user usage in the standalone playground
- Analytics of embedded playground in other websites
- User activities & feedbacks
The standalone playground and embedding guidelines with be publicly accessible for everyone to use for free. The entire project will also be fully open-source, encouraging community contributions and future development.
[CAPABILITY & FEASIBILITY] What is your capability to deliver your project with high levels of trust and accountability? How do you intend to validate if your approach is feasible?
Capability to Deliver with Trust and Accountability:
Our team has a proven track record in blockchain development, particularly within the Cardano ecosystem.
Team Overview:
- Ti Ng (Project Lead): 20 years of software development experience, specializing in blockchain.
- Phong Phu Tran (Backend Developer): 15 years of experience in backend systems.
- Quoc Vuong Do (DevOps Engineer): 10 years of experience in cloud infrastructure and CI/CD.
- Phan Thanh Long (Frontend Developer): 5 years of experience in frontend development.
We already have an MVP working and will ensure transparency through regular progress updates and milestone tracking.
[PROJECT MILESTONES] What are the key milestones you need to achieve in order to complete your project successfully?
Personalized online code editor for writing, storing & sharing code snippets in multiple programming languages
Milestone outputs:
- Personalized online code editor for writing, storing & sharing code snippets in the cloud
- Support at least Aiken, Python, Opshin, Javascript languages
Acceptance Criteria:
- Working online code editor that allows users to login, create, edit and share coding snippets
- The editor supports at least 4 programming languages: Aiken, Opshin, JavaScript, Python
Evidence of milestone completion
- Public link to the deployed online editor
- Public user guide of the editor
Built-in code runner for running & testing code in Aiken, Python & Opshin
Milestone outputs:
- Add a code runner engine that allows users to run & test code directly in the editor
- Support at least Aiken, Python, Opshin
Acceptance Criteria:
- User can run and test code directly in the editor (playground)
- Support at least Aiken, Python, Opshin
Evidence of milestone completion
- Screenshots & Video for the feature demonstration
- User guide of how to create runnable & testable code in the playground
Complete code playground and runner that can be embedded into other websites
Milestone outputs:
- The playground (editor & runner) can be embedded into other websites easily
- Add support for additional (2+) programming languages
Acceptance Criteria:
- Additional support for at least 2 programming languages
- The playground can be embedded easily into other websites
Evidence of milestone completion
- Screenshots & Video for the feature demonstration
- User guide of how to embed the playground into other websites
[RESOURCES] Who is in the project team and what are their roles?
Project Team and Roles:
- Tim Ng (Project Lead): 20 years of experience in software development, specializing in blockchain technology and Cardano ecosystem
- Phong Phu Tran (Backend Developer): 15 years of experience in backend systems and integratio
- Quoc Vuong Do (DevOps Engineer): 10 years of experience in cloud infrastructure, automation, and CI/CD processe
- Phan Thanh Long (Frontend Developer): 5 years of experience in frontend development and user interface design
[BUDGET & COSTS] Please provide a cost breakdown of the proposed work and resources
Requested Budget: ₳50,000
Cost Breakdown:
- Development Team: ₳35,000
- Infrastructure: ₳10,000
- Marketing and Outreach: ₳5,000
[VALUE FOR MONEY] How does the cost of the project represent value for money for the Cardano ecosystem?
The requested fund is actually much lower than the actual development cost needed because we already have the first MVP working in advance from our internal development.
Team
