Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
tbouffard committed Oct 13, 2023
1 parent 8c99830 commit cc2ccec
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 29 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ nvm use

If the Node version is not installed, `nvm` will state how to install the required version.

Install dependencies by running
```shell
npm install
```

### Available projects

Expand Down
10 changes: 5 additions & 5 deletions projects/lit-ts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ The application is built with [Vite](https://vitejs.dev/).

## Setup

From the project root, run `npm install`.
From the repository root, run `npm install`. For more details, see the [root README](../../README.md#setup).

If you want to use the maxGraph development version (built locally), see the README about maxGraph integration.
If you want to use the maxGraph development version (built locally), see the [root README](../../README.md#maxgraph-dev-version) about maxGraph integration.

## Running the project

Run `npm run dev` and go to http://localhost:5173/
From the repository root, run `npm run dev -w projects/lit-ts` and go to http://localhost:5173/

If you want to bundle the application, run `npm run build` and then run `npm run preview` to access to a preview of the
bundle application.
If you want to bundle the application, run `npm run build -w projects/lit-ts` and then run `npm run preview-w projects/lit-ts`
to access to a preview of the bundled application.
8 changes: 4 additions & 4 deletions projects/parcel-ts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ Parcel v2 is used in this TypeScript project: https://parceljs.org

## Setup

From the project root, run `npm install`.
From the repository root, run `npm install`. For more details, see the [root README](../../README.md#setup).

If you want to use the maxGraph development version (built locally), see the README about maxGraph integration.
If you want to use the maxGraph development version (built locally), see the [root README](../../README.md#maxgraph-dev-version) about maxGraph integration.

## Running the project

Run `npm run dev` and go to http://localhost:1234/
From the repository root, run `npm run dev -w projects/parcel-ts` and go to http://localhost:1234/

If you want to bundle the application, run `npm run build`.
If you want to bundle the application, run `npm run build -w projects/parcel-ts`.
17 changes: 7 additions & 10 deletions projects/rollup-ts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,18 @@ Adapted from https://github.com/typed-mxgraph/typed-mxgraph-example-bundled-with

### Setup

From the project root, run `npm install`.
From the repository root, run `npm install`. For more details, see the [root README](../../README.md#setup).

If you want to use the maxGraph development version (built locally), see the README about maxGraph integration.
If you want to use the maxGraph development version (built locally), see the [root README](../../README.md#maxgraph-dev-version) about maxGraph integration.

### Running the project

The `public/index.html` file contains a `<script src='bundle.js'>` tag, which means we need to create `public/bundle.js`.
The `rollup.config.js` file tells Rollup how to create this bundle, starting with `src/main.ts` and including all its dependencies,
including `mxGraph`.

`npm run build` builds the application to `dist`, along with a sourcemap file for debugging.

`npm start` launches a server, using [serve](https://github.com/zeit/serve). Navigate to http://localhost:3000/.

`npm run watch` will continually rebuild the application as your source files change.

`npm run dev` will run `npm start` and `npm run watch` in parallel.

From the project root
- `npm run build` builds the application to `dist`, along with a sourcemap file for debugging.
- `npm start` launches a server, using [serve](https://github.com/zeit/serve). Navigate to http://localhost:3000/.
- `npm run watch` will continually rebuild the application as your source files change.
- `npm run dev` will run `npm start` and `npm run watch` in parallel.
10 changes: 5 additions & 5 deletions projects/sveltekit-ts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ Initialized from [`create-svelte`](https://github.com/sveltejs/kit/tree/master/p

## Setup

From the project root, run `npm install`.
From the repository root, run `npm install`. For more details, see the [root README](../../README.md#setup).

If you want to use the maxGraph development version (built locally), see the README about maxGraph integration.
If you want to use the maxGraph development version (built locally), see the [root README](../../README.md#maxgraph-dev-version) about maxGraph integration.

## Running the project

Run `npm run dev` and go to http://localhost:5173/
From the repository root, run `npm run dev -w projects/sveltekit-ts` and go to http://localhost:5173/

If you want to bundle the application, run `npm run build` and then run `npm run preview` to access to a preview of the
bundle application.
If you want to bundle the application, run `npm run build -w projects/sveltekit-ts` and then run `npm run preview -w projects/sveltekit-ts`
to access to a preview of the bundled application.
10 changes: 5 additions & 5 deletions projects/vitejs-ts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ Initialized from https://github.com/vitejs/vite/tree/v2.9.8/packages/create-vite

## Setup

From the project root, run `npm install`.
From the repository root, run `npm install`. For more details, see the [root README](../../README.md#setup).

If you want to use the maxGraph development version (built locally), see the README about maxGraph integration.
If you want to use the maxGraph development version (built locally), see the [root README](../../README.md#maxgraph-dev-version) about maxGraph integration.

## Running the project

Run `npm run dev` and go to http://localhost:5173/
From the repository root, run `npm run dev -w projects/vitejs-ts` and go to http://localhost:5173/

If you want to bundle the application, run `npm run build` and then run `npm run preview` to access to a preview of the
bundle application.
If you want to bundle the application, run `npm run build -w projects/vitejs-ts` and then run `npm run preview -w projects/vitejs-ts`
to access to a preview of the bundled application.

0 comments on commit cc2ccec

Please sign in to comment.