mirror of
https://github.com/yldio/copilot.git
synced 2024-11-13 06:40:06 +02:00
chore: initial lerna setup
this shall be a progressive process
This commit is contained in:
parent
597f1b628b
commit
8295bd6882
3
.conventional-changelog-lintrc
Normal file
3
.conventional-changelog-lintrc
Normal file
@ -0,0 +1,3 @@
|
||||
{
|
||||
"extends": ["angular", "lerna-scopes"]
|
||||
}
|
2
.gitignore
vendored
2
.gitignore
vendored
@ -154,3 +154,5 @@ $RECYCLE.BIN/
|
||||
tap-xunit
|
||||
/ui/dist
|
||||
|
||||
_todo
|
||||
packages/*/dist
|
21
.licensesrc.json
Normal file
21
.licensesrc.json
Normal file
@ -0,0 +1,21 @@
|
||||
{
|
||||
"ignoreDevDependencies": true,
|
||||
"allowedPackages": [{
|
||||
"name": "colors",
|
||||
"extraFieldsForDocumentation": "Licence is MIT, but was not found by tool: https://github.com/Marak/colors.js/blob/v0.5.1/MIT-LICENSE.txt",
|
||||
"date": "17 January 2017",
|
||||
"reason": "MIT Licenced"
|
||||
}],
|
||||
"allowedLicenses": [
|
||||
"CC-BY-4.0",
|
||||
"CC0-1.0",
|
||||
"MIT",
|
||||
"ISC",
|
||||
"Apache",
|
||||
"BSD",
|
||||
"WTF",
|
||||
"Public Domain",
|
||||
"MPL",
|
||||
"Unlicense"
|
||||
]
|
||||
}
|
@ -2,7 +2,7 @@
|
||||
|
||||
### Small Feature Development
|
||||
|
||||
Contributors who have write access to the repository will practise continuous
|
||||
Contributors who have write access to the repository will practice continuous
|
||||
delivery (CD as known from now on in this document).
|
||||
|
||||
We will define CD in this document as a method of developing a feature per commit
|
||||
@ -22,7 +22,7 @@ In this scenario, the contributor should open a pull request instead.
|
||||
|
||||
## Commit messages
|
||||
|
||||
Follow [Git blessed](http://chris.beams.io/posts/git-commit/)
|
||||
Follow [Git blessed](http://chris.beams.io/posts/git-commit/) and [Conventional Commits](https://conventionalcommits.org)
|
||||
|
||||
1. Separate subject from body with a blank line
|
||||
2. Limit the subject line to 50 characters
|
||||
|
122
README.md
122
README.md
@ -1,120 +1,40 @@
|
||||
[![CircleCI](https://circleci.com/gh/yldio/joyent-portal.svg?style=shield&circle-token=0bbeaaafc4868c707ca0ed0568f5193a04daddb4)](https://circleci.com/gh/yldio/joyent-portal)
|
||||
[![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
|
||||
# container-pilot-dashboard
|
||||
|
||||
# Prototype Triton Portal
|
||||
[![CircleCI](https://img.shields.io/circleci/project/github/yldio/joyent-portal/master.svg?style=flat-square)](https://circleci.com/gh/yldio/joyent-portal)
|
||||
[![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg?style=flat-square)](https://opensource.org/licenses/MPL-2.0)
|
||||
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
|
||||
|
||||
This is a prototype project intended to explore some ideas that might contribute to new capabilities and a new user experience for managing applications on [Joyent's Triton](https://www.joyent.com/triton).
|
||||
> TODO: Fill out this long short description
|
||||
|
||||
**This is not intended for general use and is completely unsupported.**
|
||||
TODO: Fill out this long description.
|
||||
|
||||
## Our Principles
|
||||
We have designed this product with these principles in mind (to be completed).
|
||||
## Table of Contents
|
||||
|
||||
## Our Design Library
|
||||
We use inVision craft for our design components, you can downoad this library [here](https://drive.google.com/open?id=0Bw56g3tFwIuWOXNHUDZmRmQ3ZlE) and submit proposed changes to our Sketch wireframes [here](https://drive.google.com/open?id=0B1oWObk56wa5cE5iY2JWNmI2djg).
|
||||
- [Background](#background)
|
||||
- [Install](#install)
|
||||
- [Usage](#usage)
|
||||
- [Maintainers](#maintainers)
|
||||
- [Contribute](#contribute)
|
||||
- [License](#license)
|
||||
|
||||
## Documentation
|
||||
Our workshop meeting notes are kept in this [Google Drive folder](https://drive.google.com/open?id=0B1oWObk56wa5eklBNGFlWFRFOHM). Our meeting notes are kept in this [Google Drive folder](https://drive.google.com/open?id=0B1oWObk56wa5N1VzZjhZWWpDTTQ).
|
||||
## Background
|
||||
|
||||
## 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,
|
||||
as well as `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. [node-triton](https://github.com/joyent/node-triton)
|
||||
is also needed if deployment to Triton is required.
|
||||
## Install
|
||||
|
||||
```
|
||||
make && make install
|
||||
```
|
||||
|
||||
Then to run each individual component locally (subject to change).
|
||||
|
||||
## Setup
|
||||
|
||||
```sh
|
||||
make
|
||||
```
|
||||
|
||||
## Run services
|
||||
|
||||
To run the stack locally:
|
||||
|
||||
```sh
|
||||
docker-compose -f local-compose.yml up -d
|
||||
```
|
||||
|
||||
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),
|
||||
|
||||
## Project Management
|
||||
|
||||
This project is using [Github Projects](https://www.youtube.com/watch?v=C6MGKHkNtxU) 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.
|
||||
## Usage
|
||||
|
||||
```
|
||||
.
|
||||
├── cloudapi-graphql
|
||||
├── docs
|
||||
├── frontend
|
||||
├── nginx
|
||||
├── ui
|
||||
└── spikes
|
||||
```
|
||||
|
||||
### cloudapi-graphql
|
||||
## Maintainers
|
||||
|
||||
An implementation of the [Joyent CloudAPI](https://apidocs.joyent.com/cloudapi/) in GraphQL.
|
||||
## Contribute
|
||||
|
||||
### Docs
|
||||
See [the contribute file](CONTRIBUTING.md)!
|
||||
|
||||
Documentation about the project, mainly focused on information for the technical runnings of this project.
|
||||
Can be view online at the [documentation website](http://docs.svc.f4b20699-b323-4452-9091-977895896da6.eu-ams-1.triton.zone/)
|
||||
## License
|
||||
|
||||
### 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.
|
||||
|
||||
### Git LFS
|
||||
- We are using Git LFS to track large files, such as design files in Sketch.
|
||||
- Make sure you have this downloaded locally
|
||||
`brew install git-lfs`
|
||||
|
||||
#### Helpful tips
|
||||
- If there is an error cloning to a new machine, or there is an error cloning in the Circle CI process run `git lfs push origin master --all` from a machine that has it already checked out.
|
||||
|
||||
### Sketch Pre Commit
|
||||
|
||||
A pre-commit hook has been added to generate a PNG shot of each .sketch file "page".
|
||||
|
||||
To use, make sure the following are installed:
|
||||
- [Sketch Toolbox](http://sketchtoolbox.com/)
|
||||
- [Sketch Measure Plugin](https://github.com/utom/sketch-measure)
|
||||
|
||||
|
||||
Then add following to your `.git/config`
|
||||
|
||||
```
|
||||
[diff "sketchtool"]
|
||||
textconv = "sketchtool dump"
|
||||
cachetextconv = true
|
||||
```
|
||||
MPL-2.0
|
||||
|
0
.gitattributes → legacy/.gitattributes
vendored
0
.gitattributes → legacy/.gitattributes
vendored
156
legacy/.gitignore
vendored
Normal file
156
legacy/.gitignore
vendored
Normal file
@ -0,0 +1,156 @@
|
||||
### Bower ###
|
||||
bower_components
|
||||
.bower-cache
|
||||
.bower-registry
|
||||
.bower-tmp
|
||||
|
||||
|
||||
### Git ###
|
||||
*.orig
|
||||
|
||||
|
||||
### macOS ###
|
||||
*.DS_Store
|
||||
.AppleDouble
|
||||
.LSOverride
|
||||
|
||||
# Thumbnails
|
||||
._*
|
||||
# Files that might appear in the root of a volume
|
||||
.DocumentRevisions-V100
|
||||
.fseventsd
|
||||
.Spotlight-V100
|
||||
.TemporaryItems
|
||||
.Trashes
|
||||
.VolumeIcon.icns
|
||||
.com.apple.timemachine.donotpresent
|
||||
# Directories potentially created on remote AFP share
|
||||
.AppleDB
|
||||
.AppleDesktop
|
||||
Network Trash Folder
|
||||
Temporary Items
|
||||
.apdisk
|
||||
|
||||
|
||||
### Node ###
|
||||
# Logs
|
||||
logs
|
||||
*.log
|
||||
npm-debug.log*
|
||||
|
||||
# Runtime data
|
||||
pids
|
||||
*.pid
|
||||
*.seed
|
||||
*.pid.lock
|
||||
|
||||
# Directory for instrumented libs generated by jscoverage/JSCover
|
||||
lib-cov
|
||||
|
||||
# Coverage directory used by tools like istanbul
|
||||
coverage
|
||||
|
||||
# nyc test coverage
|
||||
.nyc_output
|
||||
|
||||
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
|
||||
.grunt
|
||||
|
||||
# node-waf configuration
|
||||
.lock-wscript
|
||||
|
||||
# Compiled binary addons (http://nodejs.org/api/addons.html)
|
||||
build/Release
|
||||
|
||||
# Dependency directories
|
||||
node_modules
|
||||
jspm_packages
|
||||
|
||||
# Optional npm cache directory
|
||||
.npm
|
||||
|
||||
# Optional eslint cache
|
||||
.eslintcache
|
||||
|
||||
# Optional REPL history
|
||||
.node_repl_history
|
||||
|
||||
# Output of 'npm pack'
|
||||
*.tgz
|
||||
|
||||
|
||||
### SublimeText ###
|
||||
# cache files for sublime text
|
||||
*.tmlanguage.cache
|
||||
*.tmPreferences.cache
|
||||
*.stTheme.cache
|
||||
|
||||
# workspace files are user-specific
|
||||
*.sublime-workspace
|
||||
|
||||
# project files should be checked into the repository, unless a significant
|
||||
# proportion of contributors will probably not be using SublimeText
|
||||
# *.sublime-project
|
||||
|
||||
# sftp configuration file
|
||||
sftp-config.json
|
||||
|
||||
# Package control specific files
|
||||
Package Control.last-run
|
||||
Package Control.ca-list
|
||||
Package Control.ca-bundle
|
||||
Package Control.system-ca-bundle
|
||||
Package Control.cache/
|
||||
Package Control.ca-certs/
|
||||
bh_unicode_properties.cache
|
||||
|
||||
# Sublime-github package stores a github token in this file
|
||||
# https://packagecontrol.io/packages/sublime-github
|
||||
GitHub.sublime-settings
|
||||
|
||||
|
||||
### Vim ###
|
||||
# swap
|
||||
[._]*.s[a-w][a-z]
|
||||
[._]s[a-w][a-z]
|
||||
# session
|
||||
Session.vim
|
||||
# temporary
|
||||
.netrwhist
|
||||
*~
|
||||
# auto-generated tag files
|
||||
tags
|
||||
|
||||
|
||||
### Windows ###
|
||||
# Windows image file caches
|
||||
Thumbs.db
|
||||
ehthumbs.db
|
||||
|
||||
# Folder config file
|
||||
Desktop.ini
|
||||
|
||||
# Recycle Bin used on file shares
|
||||
$RECYCLE.BIN/
|
||||
|
||||
# Windows Installer files
|
||||
*.cab
|
||||
*.msi
|
||||
*.msm
|
||||
*.msp
|
||||
|
||||
# Windows shortcuts
|
||||
*.lnk
|
||||
|
||||
|
||||
### Application Specific ###
|
||||
.env
|
||||
|
||||
# PostCSS
|
||||
*.postcss.js
|
||||
|
||||
/cloudapi-graphql/credentials.json
|
||||
/docker-graphql/config.json
|
||||
tap-xunit
|
||||
/ui/dist
|
||||
|
33
legacy/CONTRIBUTING.md
Normal file
33
legacy/CONTRIBUTING.md
Normal file
@ -0,0 +1,33 @@
|
||||
## Development Workflow
|
||||
|
||||
### Small Feature Development
|
||||
|
||||
Contributors who have write access to the repository will practise continuous
|
||||
delivery (CD as known from now on in this document).
|
||||
|
||||
We will define CD in this document as a method of developing a feature per commit
|
||||
with an encapsulating test that proves that the functionality is working, the
|
||||
contributor will test their code locally and if all is passing will push to *master*.
|
||||
|
||||
For contributors that do not have write access, follow the same conventions but
|
||||
open a Pull Request instead.
|
||||
|
||||
### Large changesets
|
||||
|
||||
When larger changes need to be made, or the work that is carried out spans multiple
|
||||
components / services of the application at the same time a single commit will
|
||||
not suffice.
|
||||
|
||||
In this scenario, the contributor should open a pull request instead.
|
||||
|
||||
## Commit messages
|
||||
|
||||
Follow [Git blessed](http://chris.beams.io/posts/git-commit/)
|
||||
|
||||
1. Separate subject from body with a blank line
|
||||
2. Limit the subject line to 50 characters
|
||||
3. Capitalize the subject line
|
||||
4. Do not end the subject line with a period
|
||||
5. Use the imperative mood in the subject line
|
||||
6. Wrap the body at 72 characters
|
||||
7. Use the body to explain what and why vs. how
|
120
legacy/README.md
Normal file
120
legacy/README.md
Normal file
@ -0,0 +1,120 @@
|
||||
[![CircleCI](https://circleci.com/gh/yldio/joyent-portal.svg?style=shield&circle-token=0bbeaaafc4868c707ca0ed0568f5193a04daddb4)](https://circleci.com/gh/yldio/joyent-portal)
|
||||
[![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
|
||||
|
||||
# Prototype Triton Portal
|
||||
|
||||
This is a prototype project intended to explore some ideas that might contribute to new capabilities and a new user experience for managing applications on [Joyent's Triton](https://www.joyent.com/triton).
|
||||
|
||||
**This is not intended for general use and is completely unsupported.**
|
||||
|
||||
## Our Principles
|
||||
We have designed this product with these principles in mind (to be completed).
|
||||
|
||||
## Our Design Library
|
||||
We use inVision craft for our design components, you can downoad this library [here](https://drive.google.com/open?id=0Bw56g3tFwIuWOXNHUDZmRmQ3ZlE) and submit proposed changes to our Sketch wireframes [here](https://drive.google.com/open?id=0B1oWObk56wa5cE5iY2JWNmI2djg).
|
||||
|
||||
## Documentation
|
||||
Our workshop meeting notes are kept in this [Google Drive folder](https://drive.google.com/open?id=0B1oWObk56wa5eklBNGFlWFRFOHM). Our meeting notes are kept in this [Google Drive folder](https://drive.google.com/open?id=0B1oWObk56wa5N1VzZjhZWWpDTTQ).
|
||||
|
||||
## 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,
|
||||
as well as `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. [node-triton](https://github.com/joyent/node-triton)
|
||||
is also needed if deployment to Triton is required.
|
||||
|
||||
```
|
||||
make && make install
|
||||
```
|
||||
|
||||
Then to run each individual component locally (subject to change).
|
||||
|
||||
## Setup
|
||||
|
||||
```sh
|
||||
make
|
||||
```
|
||||
|
||||
## Run services
|
||||
|
||||
To run the stack locally:
|
||||
|
||||
```sh
|
||||
docker-compose -f local-compose.yml up -d
|
||||
```
|
||||
|
||||
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),
|
||||
|
||||
## Project Management
|
||||
|
||||
This project is using [Github Projects](https://www.youtube.com/watch?v=C6MGKHkNtxU) 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
|
||||
├── docs
|
||||
├── frontend
|
||||
├── nginx
|
||||
├── ui
|
||||
└── spikes
|
||||
```
|
||||
|
||||
### cloudapi-graphql
|
||||
|
||||
An implementation of the [Joyent CloudAPI](https://apidocs.joyent.com/cloudapi/) in GraphQL.
|
||||
|
||||
### Docs
|
||||
|
||||
Documentation about the project, mainly focused on information for the technical runnings of this project.
|
||||
Can be view online at the [documentation website](http://docs.svc.f4b20699-b323-4452-9091-977895896da6.eu-ams-1.triton.zone/)
|
||||
|
||||
### 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.
|
||||
|
||||
### Git LFS
|
||||
- We are using Git LFS to track large files, such as design files in Sketch.
|
||||
- Make sure you have this downloaded locally
|
||||
`brew install git-lfs`
|
||||
|
||||
#### Helpful tips
|
||||
- If there is an error cloning to a new machine, or there is an error cloning in the Circle CI process run `git lfs push origin master --all` from a machine that has it already checked out.
|
||||
|
||||
### Sketch Pre Commit
|
||||
|
||||
A pre-commit hook has been added to generate a PNG shot of each .sketch file "page".
|
||||
|
||||
To use, make sure the following are installed:
|
||||
- [Sketch Toolbox](http://sketchtoolbox.com/)
|
||||
- [Sketch Measure Plugin](https://github.com/utom/sketch-measure)
|
||||
|
||||
|
||||
Then add following to your `.git/config`
|
||||
|
||||
```
|
||||
[diff "sketchtool"]
|
||||
textconv = "sketchtool dump"
|
||||
cachetextconv = true
|
||||
```
|
Before Width: | Height: | Size: 2.8 MiB After Width: | Height: | Size: 2.8 MiB |
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user