1
0
mirror of https://github.com/yldio/copilot.git synced 2024-11-14 07:10:05 +02:00

docs: updating setup documentation

This commit is contained in:
Tom Gallacher 2016-11-03 15:59:49 +00:00
parent 6e1e855a13
commit f09acb1738
4 changed files with 22 additions and 13 deletions

View File

@ -1,11 +1,14 @@
# Joyent Dashboard # Joyent Portal
Before you begin, you will need to install ensure that `docker` and `docker-compose` are installed correctly,
this can be done by running `make`, make continues without any errors, then you are good to go.
## Setup ## Setup
```sh ```sh
./bin/setup make
``` ```
## Installation
## Run services
To run the stack locally: To run the stack locally:
@ -13,7 +16,8 @@ To run the stack locally:
docker-compose -f local-compose.yml up -d docker-compose -f local-compose.yml up -d
``` ```
And then navigate to https://localhost:8000. This will run the front-end at [http://127.0.0.1:8000](http://127.0.0.1:8000),
the UI framework at [http://127.0.0.1:8001](http://127.0.0.1:8001),
## Development ## Development
@ -24,7 +28,7 @@ setup using the triton tool.
Currently requires [yarn](https://yarnpkg.com/en/docs/install) for installing dependencies. Currently requires [yarn](https://yarnpkg.com/en/docs/install) for installing dependencies.
``` ```
make || make install make && make install
``` ```
Then to run each individual component locally (subject to change). Then to run each individual component locally (subject to change).
@ -40,9 +44,10 @@ We will also include multiple PoC's of various bits of functionality from UI's p
``` ```
. .
├── frontend
├── ui
├── cloudapi-graphql ├── cloudapi-graphql
├── frontend
├── nginx
├── ui
└── spikes └── spikes
``` ```
@ -54,6 +59,10 @@ An implementation of the [Joyent CloudAPI](https://apidocs.joyent.com/cloudapi/)
The client side code with a dev-server, this also includes the production server for the meantime, however we are looking at moving towards a deployment of the build artifacts to manta, and another server to host these assets. The client side code with a dev-server, this also includes the production server for the meantime, however we are looking at moving towards a deployment of the build artifacts to manta, and another server to host these assets.
### nginx
Nginx will be sitting in-front of the `ui` service, allowing the `ui` to scale out.
### ui ### ui
Code for the reusable UI framework. Code for the reusable UI framework.

View File

@ -48,7 +48,7 @@ get_triton_details() {
check_docker_config() { check_docker_config() {
[[ "${DOCKER_HOST:=unset}" == "unset" ]] && { [[ "${DOCKER_HOST:=unset}" == "unset" ]] && {
echo "Run \"docker-compose -f local-compose.yml\" up to run locally" echo "Run \"docker-compose -f local-compose.yml up\" to run locally"
return 0 return 0
} }

View File

@ -70,9 +70,9 @@ nginx:
restart: always restart: always
mem_limit: 128m mem_limit: 128m
ports: ports:
- 80 - 80:80
- 443 - 443:443
- 9090 - 9090:9090
env_file: .env env_file: .env
environment: environment:
- CONSUL_AGENT=1 - CONSUL_AGENT=1

View File

@ -48,4 +48,4 @@ nginx:
links: links:
- consul:consul - consul:consul
ports: ports:
- 80 - 80:8001