Skip to content
Open
Show file tree
Hide file tree
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
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
### Install From Source
To install Sandstone IDE, first clone the repository and enter the project directory:

```
git clone https://github.com/SandstoneHPC/sandstone-ide.git
cd sandstone-ide
```

Then, build the dependencies for the front-end components:

```
cd sandstone/client
npm install
```

For OSX users that don't have ```npm``` installed please make sure to have homebrew installed first. After installing homebrew, you can then install the Node Package Manager (NPM)
with the following homebrew command

```
brew install npm
```

Switch back to the project root and install the python package (a virtualenv is recommended):

```
python setup.py install
```

### Run Sandstone IDE
Sandstone IDE can now be run with the following command:

```
sandstone
```

To use Sandstone IDE, point your browser to `localhost:8888`. For documentation on how to configure Sandstone to run over SSL or on a different port, read about [configuring Sandsto
ne settings](/docs/core/settings/).
7 changes: 7 additions & 0 deletions _docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,13 @@ cd sandstone/client
npm install
```

For OSX users that don't have ```npm``` installed please make sure to have homebrew installed first. After installing homebrew, you can then install the Node Package Manager (NPM)
with the following homebrew command

```
brew install npm
```

Switch back to the project root and install the python package (a virtualenv is recommended):

```
Expand Down