mirror of https://github.com/yldio/copilot.git synced 2024-12-01 07:30:07 +02:00

Go to file

Tom Gallacher 40c39012a5 Ensure publish occurs any other builds		2017-01-05 10:46:10 +00:00
bin	deploy: disable tls 😭	2016-11-23 14:05:39 +00:00
cloudapi-graphql	Update license to SPDX formated	2017-01-03 14:30:58 +00:00
frontend	update dependencies	2017-01-04 19:09:49 +00:00
nginx	Adding nginx as a service to load balance `ui`	2016-11-02 16:13:15 +00:00
spikes	Spike should use new chartjs box plot module	2017-01-04 16:45:31 +00:00
ui	Ensure publish occurs any other builds	2017-01-05 10:46:10 +00:00
.gitignore	upgrade frontend to styled-components	2016-12-12 10:56:48 +00:00
circle.yml	Ensure publish occurs any other builds	2017-01-05 10:46:10 +00:00
CONTRIBUTING.md	Introducing a contribution guide	2016-10-14 12:25:04 +01:00
docker-compose.yml	docs: updating setup documentation	2016-11-03 16:03:54 +00:00
LICENSE	Change license to MPL2	2016-12-09 17:39:42 +00:00
local-compose.yml	docs: updating setup documentation	2016-11-03 16:03:54 +00:00
Makefile	make: Fixing issue with finding changed files	2016-11-01 12:40:22 +00:00
package.json	Update license to SPDX formated	2017-01-03 14:30:58 +00:00
README.md	Change license to MPL2	2016-12-09 17:39:42 +00:00
yarn.lock	link dashboard and org pages	2016-12-13 22:13:46 +00:00

README.md

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

make

Run services

To run the stack locally:

docker-compose -f local-compose.yml up -d

This will run the front-end at http://127.0.0.1:8000, the UI framework at http://127.0.0.1:8001,

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 for installing dependencies.

make && make install

Then to run each individual component locally (subject to change).

Project Management

This project is using Github Projects for organisation and development of the Joyent Dashboard.

Repository Layout

Currently we are using this repository as a monolithic catch-all for all project communication, development and designs. We will also include multiple PoC's of various bits of functionality from UI's prototypes to API development.

.
├── cloudapi-graphql
├── frontend
├── nginx
├── ui
└── spikes

cloudapi-graphql

An implementation of the Joyent CloudAPI in GraphQL.

frontend

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

Code for the reusable UI framework.

spikes

Implementation examples from spikes, this directory is experimental and is likely broken.