open.source/manifold
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
fa86f5e89a
manifold/web
History
Justin fa86f5e89a
Add Users API endpoint (#547) 
* add users endpoint to API

* docs, url

* tweak docs
2022-06-25 16:28:01 -07:00
..
components Prevent duplicate Free Response answers (#581) 2022-06-25 16:18:49 -07:00
hooks Group leaderboards show members only by default 2022-06-24 18:38:39 -05:00
lib Rename "Details" to "About" 2022-06-24 18:41:02 -05:00
pages Add Users API endpoint (#547) 2022-06-25 16:28:01 -07:00
public non-cash-dropping logo gif 2022-06-13 20:32:47 -05:00
.eslintrc.js Change eslint unused var to 'warn' instead of 'error' 2022-06-15 14:48:12 -05: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 Use Typescript project references, improve functions build/deploy (#575) 2022-06-24 22:41:30 -07:00
package.json Prevent duplicate Free Response answers (#581) 2022-06-25 16:18:49 -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 Use Typescript project references, improve functions build/deploy (#575) 2022-06-24 22:41:30 -07:00

README.md

Manifold Markets web app

Getting started

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

  1. yarn to install all dependencies
  2. yarn dev:dev starts a development web server, pointing at the development database
  3. 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?