open.source/manifold
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Reorder some README stuff per feedback

Browse Source
This commit is contained in:
Marshall Polaris 2022-04-24 13:56:19 -07:00
parent 2aa6634588
commit 6202e61f7d
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
web/README.md
View File

@ -2,11 +2,6 @@
## Getting started ## Getting started
Manifold's website uses [Next.js][nextjs], which is a [React][react]-based framework that handles concerns like routing,
builds, and a development server. It's also integrated with [Vercel][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][tailwind] CSS classes.
To run the development server, install [Yarn][yarn], and then in this directory: To run the development server, install [Yarn][yarn], and then in this directory:
1. `yarn` to install all dependencies 1. `yarn` to install all dependencies
@ -15,6 +10,13 @@ To run the development server, install [Yarn][yarn], and then in this directory:
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][functions-readme].) 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][functions-readme].)
## Tech stack
Manifold's website uses [Next.js][nextjs], which is a [React][react]-based framework that handles concerns like routing,
builds, and a development server. It's also integrated with [Vercel][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][tailwind] CSS classes.
## Building and deployment ## Building and deployment
Vercel's GitHub integration monitors the repository and automatically builds (`next build`) and deploys both the `main` Vercel's GitHub integration monitors the repository and automatically builds (`next build`) and deploys both the `main`