CLI Feature: Project scaffolding

[srinjoyc]

👋   If you are interested in working on this issue, please check out the Getting Started guide on HackerEarth!

Description (Problem Statement)

Currently, there are no local tools that support scaffolding a Flow project.

For newcomers to Flow, having a suggested folder structure, as well as boilerplate configuration will save them time while experimenting or kicking off their next project.

This issue proposes a lightweight scaffolding system to be built into the Flow CLI, enabling users to quickly generate a Flow project structure based on current best practices - example scaffold.

Experience Required

• Familiarity with Go
• Familiarity with the Flow CLI
• Familiarity with frontend development, JavaScript and the Flow Client Library (FCL)

Minimum Feature Set (Acceptance Criteria)

The command should:

• Provide a pre-configured flow.json and FCL configuration to connect to the emulator and FCL development wallet.
• Provide pre-stubbed Cadence tests and JavaScript integration tests (using flow-js-testing)
• Allow users to select their preferred UI framework (or none).
  • Currently, only React and Vue are supported by FCL
• Provide a.env.example file with emulator defaults
• Provide a default .gitignore

Milestone Requirements

1. Build and implement the basic infrastructure:

• Set up GitHub repository for example projects (mix and match stacks)
• Provide issue templates for users to submit their own example project
• Generate a default React project based on Kitty Items folder layout and commit to example repo
• Propose CLI command name, flags, and other UX details for the next milestone.
• Clone the example project from the CLI using a new built-in command and interactive command line UI similar to Create Nuxt App

Software Requirements

Maintainability

• The tools or libraries used to construct the solution should be well vetted and well maintained
• Code should be written in a way where it's easily extensible to new functionality and semantic enough for open-source developers to contribute to.

Testing

• All core logic should have unit tests.
• E2E tests for each feature implemented.

Other Requirements

Documentation

• The following pieces of documentation needs to be completed alongside the code for a successful submission:
  • A quick walkthrough guide for this feature with screenshot examples.

Code standards or guidelines

• Follow the general contribution guidelines.

Judging Criteria

• For all projects, technical & high-level judging criteria apply.

Resources

• General Resource Guide
• CLI
  • Repository
  • Design guidelines
• Create Nuxt App
• Example scaffold

[10thfloor]

Hello there.
Mackenzie here. 🏄🏼‍♂️ I'm part of the Developer Experience team at Flow. Glad you're checking out this issue.
I can help answer any questions you might have about what you see here, and if you decide to take this on, I'll be your primary point of contact for you or your team.

Please add your comments/questions here, or find me on the Flow Discord (mack)

Happy hacking!
🚀

[eburnette]

The example scaffold link in the OP is broken.

[psiemens]

@eburnette Thanks, it should work now

[flyinglimao]

Hi @10thfloor , I'm interested in it.
HackerEarth Team: flyinglimao
I'm working solo but may have another member later, can I update this comment then?
I'm planing to finish this before 10/23

[psiemens]

Sure thing @flyinglimao, that works!

[10thfloor]

@flyinglimao How is the project going so far?

[flyinglimao]

Working on it but I think it's a bit hard for me to finish it this week

[flyinglimao]

Hi @10thfloor, I finished the feature (repo) but have some problems with writing tests.
I found the most tests were written for flow networks (accounts, blocks...). Is it proper that move codes into a service? If not, how can I write the test for the feature?
May I have some hints or advice? Thanks!

(edit: I saw some PR add test in internal/<folder>/<file>_test.go, I will work on this way first.)
(edit 2: still not come up with an idea on writing test, gonna submit first)