diff --git a/DEVELOPER.md b/DEVELOPER.md new file mode 100644 index 0000000..250fec4 --- /dev/null +++ b/DEVELOPER.md @@ -0,0 +1,29 @@ +# Details for Developers + +## Libraries + +### Next JS + +This app is built using Next.JS using the App Router structure. +However, to avoid common issues with wallet integrations and SSR, the app is run entirely client-side, which the exception of the auto-stake-activation feature which is a backend API. + +### Wagmi + Viem + RainbowKit + +This app uses Viem as the engine for chain interaction, RainbowKit for wallet selection, and Wagmi to tie them together into React Hooks. + +### TailwindCSS + HeadlessUI + DaisyUI + +The app is styled almost entirely with TailwindCSS. +It also uses some reusable components from Headless (e.g. for modals). +And also DaisyUI for some theming and additional components. + +## Code structure + +- The pages are defined in the /src/app folder +- Business logic such as chain queries and interactions are in /src/features +- Generic, reusable components are in /src/components +- Constants and configs are in /src/config + +## Runtime + +Currently the app is configured to be run on Vercel. However, since the app runs entirely client-side, it could be restructured to be served from more decentralized infra like Fleek or IPFS, although the auto-stake-activation feature would be tricky to port. diff --git a/README.md b/README.md index b475498..1bc546f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,3 @@ -# **WORK IN PROGRESS** - -Everything is still very much in flux. - # Celo Station Celo Station is a [DApp](https://en.wikipedia.org/wiki/Decentralized_application) for participating in staking and governance on [Celo](https://celo.org). @@ -21,3 +17,5 @@ For support, you can [file an issue](https://github.com/jmrossy/celo-station/iss 1. Install: `yarn` 2. Setup: `yarn prepare` 3. Run locally: `yarn dev` + +For more information about the architecture and internals of this app, see [DEVELOPER.md](./DEVELOPER.md). diff --git a/public/android-chrome-192x192.png b/public/android-chrome-192x192.png index 1521b78..cd8e608 100644 Binary files a/public/android-chrome-192x192.png and b/public/android-chrome-192x192.png differ diff --git a/public/android-chrome-512x512.png b/public/android-chrome-512x512.png index 730f35b..d439bda 100644 Binary files a/public/android-chrome-512x512.png and b/public/android-chrome-512x512.png differ diff --git a/public/apple-touch-icon.png b/public/apple-touch-icon.png index 7afa44f..d8a7e6a 100644 Binary files a/public/apple-touch-icon.png and b/public/apple-touch-icon.png differ diff --git a/public/favicon-16x16.png b/public/favicon-16x16.png index bda1a19..122ec7f 100644 Binary files a/public/favicon-16x16.png and b/public/favicon-16x16.png differ diff --git a/public/favicon-32x32.png b/public/favicon-32x32.png index 1e3f7a3..8536719 100644 Binary files a/public/favicon-32x32.png and b/public/favicon-32x32.png differ diff --git a/public/favicon.ico b/public/favicon.ico deleted file mode 100644 index 9f5e6d3..0000000 Binary files a/public/favicon.ico and /dev/null differ diff --git a/public/favicon.png b/public/favicon.png index 3d7be04..a3a694a 100644 Binary files a/public/favicon.png and b/public/favicon.png differ diff --git a/public/mstile-150x150.png b/public/mstile-150x150.png index cfcdc85..3cd2b70 100644 Binary files a/public/mstile-150x150.png and b/public/mstile-150x150.png differ diff --git a/public/safari-pinned-tab.svg b/public/safari-pinned-tab.svg index a2da8fc..4ea740e 100644 --- a/public/safari-pinned-tab.svg +++ b/public/safari-pinned-tab.svg @@ -4,9 +4,6 @@ - -Created by potrace 1.14, written by Peter Selinger 2001-2017 -