Skip to content
This repository has been archived by the owner on Sep 14, 2019. It is now read-only.

Latest commit

 

History

History
37 lines (28 loc) · 1.72 KB

README.md

File metadata and controls

37 lines (28 loc) · 1.72 KB
Raw

interstellar-workspace

This repository gets developers quickly started with developing on the interstellar-client which is part of the Interstellar Module System

interstellar apps are made up of multiple modules. When developing modules/widgets alongside an app, it is useful to have the modules symlinked so that changes can be immediately reflected.

Node.js' package manager, npm, provides this functionality through the npm link command. This repository leverages npm-workspace to easily link all the interstellar modules as node dependencies where needed.

Prerequisites

  1. Make sure you have: git, node v0.10, npm, and make. On ubuntu, run sudo apt-get install build-essential.
  2. Install interstellar:
npm install -g interstellar

Usage

  1. Clone this repo:
git clone https://github.com/stellar/interstellar-workspace
## or git clone git@github.com:stellar/interstellar-workspace.git
  1. Make sure you are using node v0.10.. Run node -v to see. If not, use nvm to install v0.10. alongside your current version.
  2. Clone all necessary modules by running the init script:
./init.sh
  1. npm install -g npm-workspace
  2. npm-workspace install
  3. Now you are ready to develop:
cd interstellar-client
interstellar develop