Skip to content

Commit

Permalink
chore: update doca
Browse files Browse the repository at this point in the history
  • Loading branch information
soulsam480 committed Nov 3, 2024
1 parent 53a6484 commit e659e3a
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 2 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
# okane

> money
## Goals
- simple to develop and maintain
- try as many new tech as possible with speed and simplicity in mind

## How it works ?
### server side
- app is written in gleam (:heart:)
- wisp is the http routing layer
- it follows a loose rails structure
- so requests flow in the following order
- hooks <- can early terminate requests
- router <- resource specific modules which export a controller method
- serializer <- serialize DB records to json
- response
- for DB, sqlight is used, queries via cake
- DB records are represented as gleam records, with builder pattern for ops like insert, select etc.
- radiate for hot reloading during development

### client side
- app is served from priv/ui on /
- only session is hydrated on page load
- components and re-render via preact + htm + signals
- styles are tailwind + daisy UI
4 changes: 2 additions & 2 deletions tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@
"DOM"
],
"target": "ESNext",
"module": "ESNext",
"module": "NodeNext",
"moduleDetection": "force",
"jsx": "react-jsx",
"allowJs": true,
// Bundler mode
"moduleResolution": "Classic",
"moduleResolution": "NodeNext",
"allowImportingTsExtensions": true,
"verbatimModuleSyntax": true,
"noEmit": true,
Expand Down

0 comments on commit e659e3a

Please sign in to comment.