mirror of
				https://github.com/Instadapp/assembly.git
				synced 2024-07-29 22:37:06 +00:00 
			
		
		
		
	The Open Source Dashboard for the Instadapp Protocol
			
		
		| abis/read | ||
| assets | ||
| components | ||
| composables | ||
| constant | ||
| core/entity | ||
| layouts | ||
| pages | ||
| plugins | ||
| static | ||
| store | ||
| utils | ||
| .editorconfig | ||
| .env.example | ||
| .gitignore | ||
| banner.png | ||
| jsconfig.json | ||
| nuxt.config.js | ||
| package.json | ||
| README.md | ||
| shims.d.ts | ||
| tailwind.config.js | ||
| tsconfig.json | ||
| yarn.lock | ||
Assembly
 
Directory Structure
.
├── ...
├── composables             
│   ├── protocols/          # Logic for protocols, example `useAave2Position.ts`
│   ├── ...       
│   └── ...                  
├── ...
├── components             
│   ├── protocols/          # Contains components used for protocols, example `CardAave.vue`
│   ├── sidebar/            # Contains all sidebar components, check `useSidebar.ts`
│   └── ...                   
├── ...
├── pages             
│   ├── mainnet/            # Apps for Mainnet network
│   ├── polygon/            # Apps for Polygon network
│   └── index.vue           # List all avaiable apps             
└── ...
Creating new App for Mainnet
- Create a new file my-app.vueinpages/mainnetfolder, or duplicat existing protocol, ex:pages/mainnet/aave-v2.vue
- Register the new app in index.vueinappsPerNetworkarray.
- Create new protocol useMyAppPosition.tsincomposables/protocolsfolder, checkcomposables/protocols/useAaveV2Position.tsfor more details.
- Create sidebars for the new app in components/sidebar/context/my-appfolder, ex:SidebarMyAppSupply.vue, checkcomponents/sidebar/context/aave-v2for more details.
- Register the sidebars in composables/useSidebar.ts, check thesidebarsarray for more details.
Development
# install dependencies
$ yarn install
# serve with hot reload at localhost:3000
$ yarn dev
# build for production and launch server
$ yarn build
$ yarn start
# generate static project
$ yarn generate
For detailed explanation on how things work, check out the documentation.
