Skip to content
This repository was archived by the owner on Feb 21, 2019. It is now read-only.
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 56 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,61 @@ Stardust Example Code

This repository provides a set of Web visualization and graphic examples using the Stardust library.

Gettings started
----

### Requirements

Before executing these examples, make sure you have [node.js](https://nodejs.org) installed:

```bash
node -v
```
Expected output could be `v10.0.0`, otherwise please instale `node` and `npm`. You will find detailed instructions how to install these on the web.

### Clone the repository

If you prefer SSH:

```bash
git clone [email protected]:stardustjs/stardust-examples.git
```

or if you prefer HTTPS:

```bash
https://github.com/stardustjs/stardust-examples.git
```
Both will work.

### Install dependencies

Change directory into the new repository (`cd stardust-examples`) and install all dependencies:

```bash
npm install
```

Or if you prefer `yarn`:

```bash
yarn
```

### Serve examples

This package has a built-in node server from which you can serve the examples on your local machine. Therefore use one of these scripts:

| command | description |
|----------------|--------------------------------------------------------------------------|
| npm run build | Transpile all examples for distribution on an external server |
| npm run start | Serve examples on locale machine. Before serving, mind to build it first |
| npm run watch | Serve development server with hot reloads |
| npm run deploy | Deploy examples |

If you prefer `yarn`, just replace `npm run` with `yarn`. For example `yarn build`.


Example Structure
----

Expand All @@ -29,4 +84,4 @@ Common code for all examples:
"file.to.exclude",
...
]
}
}