Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 2.83 KB

README.md

File metadata and controls

52 lines (34 loc) · 2.83 KB

Manifold

This monorepo has basically everything involved in running and operating Manifold.

Getting started

  1. Make sure you have Yarn 1.x
  2. $ cd web
  3. $ yarn
  4. $ yarn dev:dev
  5. Your site will be available on http://localhost:3000

See web/README.md for more details on hacking on the web client.

General architecture

Manifold's public API and web app are hosted by Vercel. Our data has been stored in Firebase's database Cloud Firestore but we are currently migrating it to SQL hosted on Supabase.

We often use firebase and 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 seperate from the public-facing api hosted via Vercel; see functions/README.md 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/. If you want to look at how the market math works, most of that's in here (it gets called from the bet and sellBet endpoints in functions/.) Also contains in common/envs configuration 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. We would prefer 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 as well.

Mutable.ai Auto Wiki