Skip to content

Commit 08e3e10

Browse files
authored
Create README.md
1 parent cc9d9f8 commit 08e3e10

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# strategy-template-assemblyscript
2+
AssemblyScript based Strategy Template for the Steer Protocol.
3+
4+
Start building on [Steer Protocol](https://steer.finance) with our AssemblyScript template. Expand your smart contract capabilities with off-chain compute! More info can be found here: [Documentation](https://docs.steer.finance/steer-apps/writing-an-app)
5+
6+
## Tip!
7+
8+
[Use our one-click in-browser development environment](https://bit.ly/3BsQ3DT)
9+
10+
## Project Structure
11+
Apps have three external functions that are used by the Steer system. Additional methods, classes, or varaibles can be used in conjunction with these required functions for any desired behavior. For more information please see the app interface. This design means, that as a developer, you only need to implement the methods which are required for the app to work.
12+
13+
Below are the significant files and folders which you will want to get familiar with:
14+
15+
```
16+
├── assembly // Source code for the app
17+
├── build // Output of the build process aka `yarn asbuild`
18+
├── coverage // Coverage report for testing
19+
├── tests // Test files with a built in test runner
20+
├── asconfig.json // Assemblyscript config
21+
├── index.js // Javascript entrypoint for the app when running tests
22+
├── package.json // Dependencies for the app
23+
```
24+
25+
## Project Setup
26+
Once the template has been cloned, you will need to install the project dependencies. This can be done via the following command:
27+
28+
```yarn install```
29+
30+
INFO
31+
You will notice that there is a post-install script which will compile the ./assembly source folder and populate the ./build folder. This is done to make it easier to run the tests. We will cover this later.
32+
33+
Once you have set up your project, you can begin defining your app.
34+

0 commit comments

Comments
 (0)