Skip to content

Commit

Permalink
Add Developer.md and update favicons
Browse files Browse the repository at this point in the history
  • Loading branch information
jmrossy committed Apr 13, 2024
1 parent 3f196db commit 7e25a75
Show file tree
Hide file tree
Showing 11 changed files with 31 additions and 7 deletions.
29 changes: 29 additions & 0 deletions DEVELOPER.md
Original file line number Diff line number Diff line change
@@ -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.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).
Expand All @@ -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).
Binary file modified public/android-chrome-192x192.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/android-chrome-512x512.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/apple-touch-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/favicon-16x16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/favicon-32x32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed public/favicon.ico
Binary file not shown.
Binary file modified public/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/mstile-150x150.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions public/safari-pinned-tab.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7e25a75

Please sign in to comment.