Quick Start Guide

[DavieReid]

Create a new Quick Start Guide for creating a new mosaic site.

Probably best to create a new generator that does not add mosaic specific sources but instead adds some sample docs.

Prerequisites

yarn v1
Node v 16+

Steps

1. yarn init - to create a package.json
2. yarn add @jpmorganchase/mosaic-create-site -W
3. yarn mosaic-create-site init
4. yarn mosaic-create-site create -i -o site
5. cd site
6. yarn build
7. yarn serve

NOTES

When adding to an existing monorepo as a new site package, had to run prettier on the generated site.

[origami-z]

Maybe need to add yarn being pre-requisite..? Yarn init may also be a valid command if the rest is all yarn?

[Unnati-Sadh]

I want to contribute to this repo, the following steps can be followed:
Quick Start Guide: Creating a New Mosaic Site

Steps:

1. Initialize a new project:
   Run the following command to create a package.json file:

yarn init

2. Install the Mosaic Create Site package:
   Add the @jpmorganchase/mosaic-create-site package as a dev dependency:

yarn add @jpmorganchase/mosaic-create-site -D

3. Initialize the Mosaic site:
   Run the initialization command to set up the Mosaic site structure:

yarn mosaic-create-site init

4. Create sample documents:
   Use the following command to generate sample documents on the site:

yarn mosaic-create-site create -i -o site

Note: The -i flag indicates that the generator should not add mosaic-specific sources but instead add sample documents.

5. Navigate to the site directory:
   Change into the newly created site directory:

cd site

6. Build the Mosaic site:
   Use the following command to build the Mosaic site:

yarn build

7. Serve the Mosaic site:
   Start a local development server to serve the Mosaic site:

yarn serve