From 82b9b17dda8518e1c9dedacb8574f2d67706dc1a Mon Sep 17 00:00:00 2001 From: Georges KABBOUCHI Date: Sat, 14 Aug 2021 00:35:37 +0300 Subject: [PATCH] add basic instruction how to create a new app --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 625c6da..c255631 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,14 @@ │ └── index.vue # List all avaiable apps └── ... +## Creating new App for Mainnet + +- Create a new file `my-app.vue` in `pages/mainnet` folder, or duplicat existing protocol, ex: `pages/mainnet/aave-v2.vue` +- Register the new app in `index.vue` in `appsPerNetwork` array. +- Create new protocol `useMyAppPosition.ts` in `composables/protocols` folder, check `composables/protocols/useAaveV2Position.ts` for more details. +- Create sidebars for the new app in `components/sidebar/context/my-app` folder, ex: `SidebarMyAppSupply.vue`, check `components/sidebar/context/aave-v2` for more details. +- Register the sidebars in `composables/useSidebar.ts`, check the `sidebars` array for more details. + ## Development ```bash