-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
1,594 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,81 +1,4 @@ | ||
| ### 👋 Welcome Flow Developer! | ||
| Welcome to your new Flow project. We only provided you with bare minimum to get started, which is the standard Cadence folder structure and a flow.json configuration with standard contracts defined. | ||
| ## FLOWVO 💎 | ||
|
|
||
| ### 🔨 Getting started | ||
| Getting started can feel overwhelming, but we are here for you. Depending on how accustomed you are to Flow here's a list of resources you might find useful: | ||
| - **[Cadence documentation](https://developers.flow.com/cadence/language)**: here you will find language reference for Cadence, which will be the language in which you develop your smart contracts, | ||
| - **[Visual Studio Code](https://code.visualstudio.com/?wt.mc_id=DX_841432)** and **[Cadence extension](https://marketplace.visualstudio.com/items?itemName=onflow.cadence)**: we suggest using Visual Studio Code IDE for writing Cadence with the Cadence extension installed, that will give you nice syntax highlitning and additional smart features, | ||
| - **[SDKs](https://developers.flow.com/tools#sdks)**: here you will find a list of SDKs you can use to ease the interaction with Flow network (sending transactions, fetching accounts etc), | ||
| - **[Tools](https://developers.flow.com/tools#development-tools)**: development tools you can use to make your development easier, [Flowser](https://docs.flowser.dev/) can be super handy to see what's going on the blockchain while you develop | ||
| #### A platform for decentralized decision making within DAOs and Token Gated Communities | ||
|
|
||
|
|
||
| ### 📦 Project Structure | ||
| Your project comes with some standard folders which have a special purpose: | ||
| - `/cadence` inside here is where your Cadence smart contracts code lives | ||
| - `flow.json` configuration file for your project, you can think of it as package.json, but you don't need to worry, flow dev command will configure it for you | ||
|
|
||
| Inside `cadence` folder you will find: | ||
| - `/contracts` location for Cadence contracts go in this folder | ||
| - `/scripts` location for Cadence scripts goes here | ||
| - `/transactions` location for Cadence transactions goes in this folder | ||
| - `/tests` all the integration tests for your dapp and Cadence tests go into this folder | ||
|
|
||
|
|
||
| ### 👨💻 Start Developing | ||
| After creating this project using the flow setup command you should then start the emulator by running: | ||
| ``` | ||
| > flow emulator --contracts | ||
| ``` | ||
| _we use `--contracts` flag to include more already deployed contract we can then easily import in our project._ | ||
|
|
||
| and then start the development command by running: | ||
| ```shell | ||
| > flow dev | ||
| ``` | ||
| After the command is started it will automatically watch any changes you make to Cadence files and make sure to continiously sync those changes on the emulator network. If you make any mistakes it will report the errors as well. Read more [about the command here](https://developers.flow.com/tools/flow-cli/super-commands) | ||
|
|
||
| **Importing Contracts** | ||
|
|
||
| When you want to import the contracts you've just created you can simply do so by writing the import statement: | ||
| ``` | ||
| import "Foo" | ||
| ``` | ||
| We will automatically find your project contract named `Foo` and handle the importing for you. | ||
|
|
||
| **Deploying to specific accounts** | ||
|
|
||
| By default all contracts are deployed to a default account. If you want to seperate contracts to different accounts you can easily do so by creating a folder inside the contracts folder and we will create the account for you which will have the same name as the folder you just created. All the contracts inside that folder will be deployed automatically to the newly created account. | ||
|
|
||
| Example deploying to charlie account: | ||
|
|
||
| _folder structure_ | ||
| ``` | ||
| /contracts | ||
| Bar.cdc | ||
| /charlie | ||
| Foo.cdc | ||
| ``` | ||
|
|
||
| You can then import the `Foo` contract in `Bar` contract the same way as any other contract: | ||
| ``` | ||
| import "Foo" | ||
| ``` | ||
|
|
||
| **Included Imports** | ||
|
|
||
| You can already import certain common contracts we included for you, just make sure you started your emulator with the `--contracts` flag so those contracts are really deployed. The list of contracts you can import out of the box is: | ||
| - NonFungibleToken `import "NonFungibleToken"` | ||
| - FlowToken `import "FlowToken"` | ||
| - FungibleToken `import "FungibleToken"` | ||
| - FUSD `import "FUSD"` | ||
| - MetadataViews `import "MetadataViews"` | ||
| - ExampleNFT `import "ExampleNFT"` | ||
| - NFTStorefrontV2 `import "NFTStorefrontV2"` | ||
| - NFTStorefront `import "NFTStorefront"` | ||
|
|
||
|
|
||
| ### Further Reading | ||
|
|
||
| - Cadence Language Reference https://developers.flow.com/cadence/language | ||
| - Flow Smart Contract Project Development Standards https://developers.flow.com/cadence/style-guide/project-development-tips | ||
| - Cadence anti-patterns https://developers.flow.com/cadence/anti-patterns |
Oops, something went wrong.