History

Austin Chen 2a134b3c9a Add a box for contributing to the bounty		2022-08-16 10:52:43 -07:00
..
components	Add a box for contributing to the bounty	2022-08-16 10:52:43 -07:00
hooks	Rewrite `useQueryAndSortParams` machinery to be faster/simpler/better (#758 )	2022-08-14 22:09:25 -07:00
lib	Scaffold endpoint to add to a bounty	2022-08-15 16:37:23 -07:00
pages	Add a box for contributing to the bounty	2022-08-16 10:52:43 -07:00
public	noobify welcome demo (#699 )	2022-07-30 02:50:03 -05:00
.eslintrc.js	Fix up lint configuration, lint line endings (#615 )	2022-07-05 12:25:44 -07:00
.gitignore	Run a ts type checker in parallel with nextjs dev process	2021-12-19 15:26:59 -06:00
.prettierignore	Host Ida and Alex's MTG Guesser game (#656 )	2022-07-20 16:57:51 -07:00
.yarnrc	when adding package, don't put ^ before version (#645 )	2022-07-13 15:14:06 -07:00
get-manalink-url.ts	initial commit for manalinks UI improvements (#642 )	2022-07-13 16:57:34 -05: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	Experimentally do not optimizeCss	2022-08-11 21:07:54 -07:00
package.json	Simplify and fix inefficiencies in contract search component (#756 )	2022-08-13 13:15:11 -07:00
postcss.config.js	Prettier: no semi, spaces 2, single quote, trailing comma	2021-12-02 17:49:46 -06:00
README.md	Tweak readme	2022-08-14 21:10:09 -07:00
tailwind.config.js	noobify welcome demo (#699 )	2022-07-30 02:50:03 -05:00
tsconfig.json	Typescript project references take 2 (#586 )	2022-06-27 13:32:24 -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 dev: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?