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

readme: updating docs

Browse Source
This commit is contained in:
Tom Gallacher 2016-10-25 17:51:20 +01:00
parent dfa4ff8bad
commit 61ea8e4baa
1 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -1,5 +1,29 @@
# Joyent Dashboard
## Installation
To run the stack locally:
```sh
docker-compose -f local-compose.yml up -d
```
And then navigate to https://localhost:8000.
## Development
If you would like to contribute to the project, the recommended way to setup is to
insure that you have docker installed, and optionally have a triton account and profile
setup using the triton tool.
Currently requires [yarn](https://yarnpkg.com/en/docs/install) for installing dependencies.
```
make || make install
```
Then to run each individual component locally (subject to change).
## Project Management
This project is using [Github Projects](https://www.youtube.com/watch?v=C6MGKHkNtxU) for organisation and development of the Joyent Dashboard.
@ -31,4 +55,4 @@ Code for the reusable UI framework.
### spikes
Implementation examples from spikes.
Implementation examples from spikes, this directory is experimental and is likely broken.