Spearhead/joyent-portal
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs: initial getting started docs

Browse Source
This commit is contained in:
Sérgio Ramos 2017-06-06 10:53:49 +01:00
parent 7b9a40a8f9
commit 527f046693
1 changed files with 81 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
GETTING_STARTED.md Normal file
View File

@ -0,0 +1,81 @@
# Getting Started
## Setup the project
**Install Node.js**, preferably 8.0:
```
λ brew install node
```
with [n](https://github.com/tj/n):
```
λ n 8.0.0
```
**Install ZMQ**:
```
λ brew install zmq
```
**Clone repo**:
```
λ git clone git@github.com:yldio/joyent-portal.git
Cloning into 'joyent-portal'...
remote: Counting objects: 13702, done.
remote: Compressing objects: 100% (146/146), done.
remote: Total 13702 (delta 89), reused 138 (delta 53), pack-reused 13491
Receiving objects: 100% (13702/13702), 15.08 MiB | 5.44 MiB/s, done.
Resolving deltas: 100% (8824/8824), done.
Downloading legacy/design/ui-library.sketch (8.48 MB)
Checking out files: 100% (1795/1795), done.
λ cd joyent-portal
```
**Install dependendencies**:
```
joyent-portal:master λ yarn
yarn install v0.24.6
[1/5] 🔍 Resolving packages...
[2/5] 🚚 Fetching packages...
[3/5] 🔗 Linking dependencies...
[4/5] 📃 Building fresh packages...
[5/5] ♻️ Cleaning modules...
$ redrun -s clean bootstrap
> lerna clean --yes && lerna bootstrap
lerna info version 2.0.0-rc.5
lerna info versioning independent
lerna info clean removing /Users/ramitos/dev/yld/joyent-portal/packages/babel-preset/node_modules
lerna info clean removing /Users/ramitos/dev/yld/joyent-portal/packages/cloudapi-gql/node_modules
lerna info clean removing /Users/ramitos/dev/yld/joyent-portal/packages/cp-frontend/node_modules
lerna info clean removing /Users/ramitos/dev/yld/joyent-portal/packages/cp-gql-mock-server/node_modules
lerna info clean removing /Users/ramitos/dev/yld/joyent-portal/packages/cp-gql-schema/node_modules
lerna info clean removing /Users/ramitos/dev/yld/joyent-portal/packages/cp-rdb-bootstrap/node_modules
lerna info clean removing /Users/ramitos/dev/yld/joyent-portal/packages/docker-compose-client/node_modules
lerna info clean removing /Users/ramitos/dev/yld/joyent-portal/packages/eslint-config/node_modules
lerna info clean removing /Users/ramitos/dev/yld/joyent-portal/packages/normalized-styled-components/node_modules
lerna info clean removing /Users/ramitos/dev/yld/joyent-portal/packages/portal-api/node_modules
lerna info clean removing /Users/ramitos/dev/yld/joyent-portal/packages/portal-data/node_modules
lerna info clean removing /Users/ramitos/dev/yld/joyent-portal/packages/pseudo-json-ast/node_modules
lerna info clean removing /Users/ramitos/dev/yld/joyent-portal/packages/pseudo-yaml-ast/node_modules
lerna info clean removing /Users/ramitos/dev/yld/joyent-portal/packages/remcalc/node_modules
lerna info clean removing /Users/ramitos/dev/yld/joyent-portal/packages/rnd-id/node_modules
lerna info clean removing /Users/ramitos/dev/yld/joyent-portal/packages/styled-is/node_modules
lerna info clean removing /Users/ramitos/dev/yld/joyent-portal/packages/ui-toolkit/node_modules
lerna info clean removing /Users/ramitos/dev/yld/joyent-portal/packages/unitcalc/node_modules
lerna success clean finished
lerna info version 2.0.0-rc.5
lerna info versioning independent
lerna info Bootstrapping 18 packages
lerna info lifecycle preinstall
lerna info Installing external dependencies
lerna info Symlinking packages and binaries
lerna info lifecycle postinstall
lerna info lifecycle prepublish
lerna success Bootstrapped 18 packages
✨ Done in 297.44s.
```