2020-03-02 13:37:00 -05:00
|
|
|
<<<<<<< HEAD
|
2020-02-13 19:43:20 -03:00
|
|
|
# Basic Docz example
|
2019-08-13 15:36:46 -04:00
|
|
|
|
2020-02-13 19:43:20 -03:00
|
|
|
## Using `create-docz-app`
|
2019-08-13 15:36:46 -04:00
|
|
|
|
2020-02-13 19:43:20 -03:00
|
|
|
```sh
|
|
|
|
|
npx create-docz-app docz-app-basic
|
|
|
|
|
# or
|
|
|
|
|
yarn create docz-app docz-app-basic
|
2019-08-13 15:36:46 -04:00
|
|
|
```
|
|
|
|
|
|
2020-02-13 19:43:20 -03:00
|
|
|
## Download manually
|
2019-08-13 15:36:46 -04:00
|
|
|
|
2020-02-13 19:43:20 -03:00
|
|
|
```sh
|
|
|
|
|
curl https://codeload.github.com/doczjs/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/basic
|
|
|
|
|
mv basic docz-basic-example
|
|
|
|
|
cd docz-basic-example
|
2019-08-13 15:36:46 -04:00
|
|
|
```
|
|
|
|
|
|
2020-02-13 19:43:20 -03:00
|
|
|
## Setup
|
2019-08-13 15:36:46 -04:00
|
|
|
|
2020-02-13 19:43:20 -03:00
|
|
|
```sh
|
|
|
|
|
yarn # npm i
|
2019-08-13 15:36:46 -04:00
|
|
|
```
|
|
|
|
|
|
2020-02-13 19:43:20 -03:00
|
|
|
## Run
|
2019-08-13 15:36:46 -04:00
|
|
|
|
2020-02-13 19:43:20 -03:00
|
|
|
```sh
|
|
|
|
|
yarn dev # npm run dev
|
|
|
|
|
```
|
2019-08-13 15:36:46 -04:00
|
|
|
|
2020-02-13 19:43:20 -03:00
|
|
|
## Build
|
2019-08-13 15:36:46 -04:00
|
|
|
|
2020-02-13 19:43:20 -03:00
|
|
|
```sh
|
|
|
|
|
yarn build # npm run build
|
|
|
|
|
```
|
2019-08-13 15:36:46 -04:00
|
|
|
|
2020-02-13 19:43:20 -03:00
|
|
|
## Serve built app
|
2019-08-13 15:36:46 -04:00
|
|
|
|
2020-02-13 19:43:20 -03:00
|
|
|
```sh
|
|
|
|
|
yarn serve # npm run serve
|
2020-03-02 13:37:00 -05:00
|
|
|
```
|
|
|
|
|
=======
|
|
|
|
|
# @ohif/ui
|
|
|
|
|
|
|
|
|
|
React component library powered by `docz`
|
|
|
|
|
|
|
|
|
|
## Commands
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
# Install
|
|
|
|
|
yarn # npm i
|
|
|
|
|
|
|
|
|
|
# Develop
|
|
|
|
|
yarn dev # npm run dev
|
|
|
|
|
|
|
|
|
|
# Build
|
|
|
|
|
yarn build # npm run build
|
|
|
|
|
|
|
|
|
|
# Serve (the "build" output)
|
|
|
|
|
yarn serve # npm run serve
|
|
|
|
|
```
|
|
|
|
|
>>>>>>> 4a8675655... feat: nuke UI project; start new with updated tooling BREAKING_CHANGE (#1468)
|