Skip to content

Commit

Permalink
update docs readme to include client/server build steps
Browse files Browse the repository at this point in the history
The docs reference the outputs from client, server generate
steps. So this is necessary.
  • Loading branch information
nick-funk committed Aug 21, 2023
1 parent 37e3fdc commit d0bcfa8
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,21 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta

## Installation

First, you'll need to do at least one full build of Coral. In the root of the repository, peform the following.

```bash
npm install
sh npm-i.sh
sh build-development.sh
```

The reason for this is that the docs references the `client/` and `server/` generated types and components to populate the live docs information.

## Local Development

Then within `docs/` you can run the following:

```bash
npm start
npm run start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

0 comments on commit d0bcfa8

Please sign in to comment.