Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
added repo structure
  • Loading branch information
mostarz93 authored Mar 7, 2023
1 parent c6d3f81 commit b60fffe
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,3 +99,33 @@ Sync with: `yarn syncDevLocales` **must provide api key**
Check sync changes with: `yarn checkDevLocales`

Download prod locales with: `yarn downloadProdLocales`



## Repo Structure

'''
|
|- public
|- locales = Where we store all copy translations that you see on the page
| src
|- config = all env vars and constants
|- client = all React/HTML/CSS
|- tests = testing services
|- utils = small helper functinos throughout the codebase
|- core
|- types = data structs for entire codebase
|- State = for redux state data structs
|- Service = Credit + Collateral + other services
|- CreditLine = anything related to credit specifically
|- frameworks = 3rd party dependency integrations (ethersjs, subgraph, blocknative)
|- services = Libs for composing frameworks in actions for users
|- Tx = sending txs
|- CreditLine = interacting with credit/debt positions
|- Collateral = interacting with line collateral (Spigot + Escrow)
|- OnchainMetadata = ens + abis + ?
|- store = Redux. dynamic state about marketplace, user, tokens, etc. + actions to query/interact

'''


0 comments on commit b60fffe

Please sign in to comment.