From 527f04669366776ffd4c6f4fbf14a58b88f58098 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Se=CC=81rgio=20Ramos?= Date: Tue, 6 Jun 2017 10:53:49 +0100 Subject: [PATCH] docs: initial getting started docs --- GETTING_STARTED.md | 81 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 GETTING_STARTED.md diff --git a/GETTING_STARTED.md b/GETTING_STARTED.md new file mode 100644 index 00000000..750fd09a --- /dev/null +++ b/GETTING_STARTED.md @@ -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. +```