Manifold
This [monorepo][monorepo] has basically everything involved in running and operating Manifold.
Getting started
- Make sure you have [Yarn 1.x][yarn]
$ cd web$ yarn$ yarn dev:dev- Your site will be available on http://localhost:3000
web/README.md][web-readme] for more details on hacking on the web client.
General architecture
Manifold's public API and web app are hosted by [Vercel][vercel]. Our data has been stored in Firebase's database [Cloud Firestore][cloud-firestore] but we have almost entirely migrated it to SQL hosted on [Supabase][supabase].
We often use supabase directly on the client to get the data. However, for complicated operations (like buying shares) we have a separate internal HTTP API deployed in a docker container in google cloud. This is separate from the public-facing api hosted via Vercel; see [functions/README.md][functions-readme] for more details.
Directory overview
- web/: UI and business logic for the client. Where most of the site lives. The public API endpoints are also in here.
- backend/: All the rest of the stuff we run on GCP.
- common/: Typescript library code shared between
web/&backend/&shared/. If you want to look at how the market math works, most of that's in here (it gets called from thebetandsellBetendpoints infunctions/.) Also contains incommon/envsconfiguration for the different environments (i.e. prod, dev, Manifold for Teams instances.)
- docs/: Manifold's public documentation that lives at https://docs.manifold.markets.
Contributing
We're pretty new to open-source culture so please be patient and let us know how we can do better. Feel free to open issues, submit PRs, and chat about the process on [Discord][discord]. We would prefer [small PRs][small-prs] that we can effectively evaluate and review - check in with us first if you want to work on a big change.
By contributing to this codebase, you are agreeing to the terms of the Manifold CLA.
If you need additional access to any infrastructure in order to work on something (e.g. Vercel, Firebase, Supabase) let us know about that on [Discord][discord] as well.
[vercel]: https://vercel.com/ [monorepo]: https://semaphoreci.com/blog/what-is-monorepo [yarn]: https://classic.yarnpkg.com/lang/en/docs/install/ [web-readme]: ./web/README.md [functions-readme]: ./backend/functions/README.md [supabase]: https://supabase.com/ [cloud-firestore]: https://firebase.google.com/docs/firestore [cloud-functions]: https://firebase.google.com/docs/functions [small-prs]: https://google.github.io/eng-practices/review/developer/small-cls.html [discord]: https://discord.gg/3Zuth9792G