open.source/manifold
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Manifold Markets: A market for every question
1,448 Commits 88 Branches 0 Tags 33 MiB
TypeScript 82.1%
HTML 16.1%
JavaScript 0.8%
Python 0.7%
CSS 0.3%
3a9a9b1c6e
Go to file
Forrest Wolf 3a9a9b1c6e Revert "Give event in Dropdown an explicit type" 
This reverts commit 80604310f2.
2022-05-25 17:14:19 -04:00
.github Set up eslint for common, functions packages (#290) 2022-05-22 00:35:43 -07:00
.vscode Switch vscode imports to "shortest" 2022-05-10 09:43:04 -04:00
common Add explicit types to removeUndefinedProps 2022-05-25 11:32:26 -04:00
functions Create StripeSession type 2022-05-25 11:37:13 -04:00
og-image Revert "Give event in Dropdown an explicit type" 2022-05-25 17:14:19 -04:00
web Give react children explicit types 2022-05-25 11:22:12 -04:00
.firebaserc Allow admins to see private-users info 2022-01-24 00:48:10 -06:00
.gitignore Single threaded comments (#175) 2022-05-11 15:11:46 -06:00
.prettierrc move prettier config to top level 2022-01-10 17:44:42 -06:00
firebase.json Reapply Manifold for Teams config changes (#54) 2022-02-26 23:29:33 -08:00
firestore.indexes.json Merge Manifold for Teams infra into main codebase (#61) 2022-03-08 18:43:30 -08:00
firestore.rules Allow users to generate an API key in their profile (#182) 2022-05-15 20:41:07 -07:00
LICENSE.md Choose MIT license 2022-04-02 12:01:23 -07:00
package.json Change lodash stuff so that it can be tree-shaken out of build (#233) 2022-05-22 01:36:05 -07:00
README.md Update README link to Discord 2022-05-02 10:14:40 -04:00
yarn.lock Add Vercel routes for public write API (#280) 2022-05-23 14:16:56 -07:00

README.md

Manifold Markets

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. In general, the web app runs as much as possible on the client; we follow a JAMStack architecture. All data is stored in Firebase's database, Cloud Firestore. This is directly accessed by the client for most data access operations.

Operations with complicated contracts (e.g. buying shares) are provided in a separate HTTP API using Firebase's Cloud Functions. Those are deployed separately from the Vercel website; 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.

  • functions/: Firebase cloud functions, for secure work (e.g. balances, Stripe payments, emails). Also contains in functions/src/scripts/ some Typescript scripts that do ad hoc CLI interaction with Firebase.

  • common/: Typescript library code shared between web/ & functions/. If you want to look at how the market math works, most of that's in here (it gets called from the placeBet and sellBet endpoints in functions/.) Also contains in common/envs configuration for the different environments (i.e. prod, dev, Manifold for Teams instances.)

  • og-image/: The OpenGraph image generator; creates the preview images shown on Twitter/social media.

Also: Our docs are currently in a separate repo. TODO: move them into this monorepo.

Contributing

Since we are just now open-sourcing things, we will see how things go. 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 -- maybe check in with us first if you are thinking 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) let us know about that on Discord as well.