open.source/manifold
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Manifold Markets: A market for every question
3,418 Commits 88 Branches 0 Tags 33 MiB
TypeScript 82.1%
HTML 16.1%
JavaScript 0.8%
Python 0.7%
CSS 0.3%
main
Go to file
Phil c762869b83
Migrate prod bot (#1052) 
* Updated dev config to point to new Twitch dev bot hosting location.

* Updated prod config to point to new Twitch bot hosting location.
2022-10-14 16:41:06 +01:00
.github Action to merge main into main2 automatically 2022-10-07 15:13:57 -05:00
.vscode add tailwind to recommended vscode extensions 2022-06-23 14:25:55 -05:00
common Migrate prod bot (#1052) 2022-10-14 16:41:06 +01:00
docs Document the new /comment endpoint 2022-10-12 17:26:00 -07:00
functions Tipping in posts (#1045) 2022-10-14 13:05:07 +01:00
og-image Remove spaces in hashtags & line clamp metadata 2022-10-04 09:14:27 -06:00
web New component to add arbitrary (but static) react embeds to posts programatically + midterms component (#1051) 2022-10-14 16:21:54 +01:00
.firebaserc Allow admins to see private-users info 2022-01-24 00:48:10 -06:00
.gitignore add tailwind to recommended vscode extensions 2022-06-23 14:25:55 -05:00
.prettierrc move prettier config to top level 2022-01-10 17:44:42 -06:00
dev.sh Allow to follow/unfollow markets, backfill as well (#794) 2022-08-24 10:49:53 -06:00
firebase.json [WIP] Fully customizable notifications (#860) 2022-09-12 10:34:56 -06:00
firestore.indexes.json Move comment-bet association code into comment creation trigger (#899) 2022-09-20 15:25:58 -07:00
firestore.rules Add flaggedByUsernames to firestore rules 2022-10-13 07:58:14 -06:00
LICENSE.md Choose MIT license 2022-04-02 12:01:23 -07:00
package.json Small add-on React 18 fixes (#1004) 2022-10-05 00:23:23 -07:00
README.md Mention /docs package in README 2022-05-31 15:16:18 -07:00
yarn.lock Update stability-client to fix /dream 2022-10-13 21:44:22 -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.

  • docs/: Manifold's public documentation that lives at https://docs.manifold.markets.

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.