open.source/manifold
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Sketch out a quick overview in README

Browse Source
This commit is contained in:
Austin Chen 2022-04-02 12:10:10 -07:00 committed by GitHub
parent b454d3eca0
commit d18cc372f6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,3 +1,14 @@
# manifold
# Manifold Markets
Manifold Markets
## Directory overview
- `web/`: UI and biz logic. Where most of the site lives
- `functions/`: Firebase cloud functions, for secure work (balances, Stripe payments, emails)
- `common/`: shared between web & functions
- `og-image/`: The OpenGraph image generator; creates the preview images shown on Twitter/social media
## Philosophies
- [JAMStack](https://jamstack.org/): Keep things simple, no servers
- [Monorepo](https://semaphoreci.com/blog/what-is-monorepo): Good fit for our current size
- [Small PRs](https://google.github.io/eng-practices/review/developer/small-cls.html): Lots of little changes > one big diff