History

Austin Chen f4c7148e7e Design in the Atlas logo		2022-06-14 03:13:10 -07:00
..
components	Design in the Atlas logo	2022-06-14 03:13:10 -07:00
hooks	Listen for contract updates when navigating from home to contract page. (#494 )	2022-06-13 11:04:56 -05:00
lib	Revert "Revert "Turn on no unused variables linting, kill dead code (#484 )""	2022-06-12 21:42:41 -07:00
pages	Fix build	2022-06-14 02:44:37 -07:00
public	Design in the Atlas logo	2022-06-14 03:13:10 -07:00
.eslintrc.js	Revert "Revert "Turn on no unused variables linting, kill dead code (#484 )""	2022-06-12 21:42:41 -07:00
.gitignore	Run a ts type checker in parallel with nextjs dev process	2021-12-19 15:26:59 -06:00
.prettierignore	Run prettier	2021-12-09 15:23:21 -08:00
next-env.d.ts	upgrade nextjs version	2021-12-15 23:49:38 -06:00
next-sitemap.js	Generate sitemap server-side	2022-03-24 09:52:13 -07:00
next.config.js	Rename /analytics to /stats to work around adblockers (#437 )	2022-06-07 08:37:23 -07:00
package.json	Set up Atlas Firebase	2022-06-12 21:02:16 -07:00
postcss.config.js	Prettier: no semi, spaces 2, single quote, trailing comma	2021-12-02 17:49:46 -06:00
README.md	A couple additions to help newbies out (#104 )	2022-04-27 13:15:14 -07:00
tailwind.config.js	Send M$ to Charity & txns (#81 )	2022-04-29 19:35:56 -04:00
tsconfig.json	Fix up target in web tsconfig (#155 )	2022-05-08 23:57:29 -07:00

README.md

Manifold Markets web app

Getting started

To run the development server, install Yarn 1.x, and then in this directory:

yarn to install all dependencies
yarn dev:dev starts a development web server, pointing at the development database
Your site will be available on http://localhost:3000

Check package.json for other command-line tasks. (e.g. yarn dev will point the development server at the prod database. yarn emulate will run against a local emulated database, if you are serving it via yarn serve from the functions/ package.)

Tech stack

Manifold's website uses Next.js, which is a React-based framework that handles concerns like routing, builds, and a development server. It's also integrated with Vercel, which is responsible for hosting the site and providing some other production functionality like serving the API. The application code is written exclusively in Typescript. Styling is done via CSS-in-JS in the React code and uses Tailwind CSS classes.

Building and deployment

Vercel's GitHub integration monitors the repository and automatically builds (next build) and deploys both the main branch (to production) and PR branches (to ephemeral staging servers that can be used for testing.)

Parts of the file structure that directly map to HTTP endpoints are organized specially per Next.js's prescriptions:

public/

These are static files that will be served by Next verbatim.

pages/

These are components that Next's router is aware of and interprets as page roots per their filename, e.g. the React component in pages/portfolio.tsx is rendered on the user portfolio page at /portfolio. You should look in here or in components/ to find any specific piece of UI you are interested in working on.

pages/api/

Modules under this route are specially interpreted by Next/Vercel as functions that will be hosted by Vercel. This is where the public Manifold HTTP API lives.

Contributing

Please format the code using Prettier; you can run yarn format to invoke it manually. It also runs by default as a pre-commit Git hook thanks to the pretty-quick package. You may wish to use some kind of fancy editor integration to format it in your editor.

Developer Experience TODOs

Prevent git pushing if there are Typescript errors?