https://github.com/cinderblock/coxswain
Daemon to handle deployments from push events
https://github.com/cinderblock/coxswain
Last synced: about 2 months ago
JSON representation
Daemon to handle deployments from push events
- Host: GitHub
- URL: https://github.com/cinderblock/coxswain
- Owner: cinderblock
- Created: 2018-12-24T02:48:25.000Z (over 7 years ago)
- Default Branch: stable
- Last Pushed: 2019-01-08T23:11:15.000Z (over 7 years ago)
- Last Synced: 2025-09-07T01:36:36.516Z (9 months ago)
- Language: JavaScript
- Size: 906 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Coxswain
Daemon to handle deployments from push events.
## Usage
WIP/TBD
## Development
### Prerequisites
[**Node 8+**](https://nodejs.org/en/download) must be installed on your development system.
```bash
npm install
```
### Running
To run this full system, **two** separate programs need to be run.
One for the web **UI** and one to actually do something persistent, the **daemon**.
Most commands are intended to be run **on your development machine** and **not** directly on the remote system.
## Cheat sheet
All of these are run from the top level directory.
| Command | Description |
| ------------------------------ | ------------------------------------------------------------ |
| `yarn setup` | Setup your local machine for development |
| `yarn ui setup dev` | Run the web **ui** in development mode on your local machine |
| `yarn daemon setup dev` | Run **daemon** in development mode on your local machine |
| `yarn ui add some-package` | Add `some-package` to the ui |
| `yarn daemon add some-package` | Add `some-package` to the daemon |
| `yarn ui upgrade` | Upgrade ui packages to latest version |
| Remote commands | Need configuration |
| ---------------------- | ----------------------------------------------------------------- |
| `yarn remote upgrade` | Upgrade daemon packages to latest version using the remote's yarn |
| `yarn remote kill` | Kill the daemon on remote |
| `yarn remote shutdown` | Shutdown the remote system |
| `yarn remote reboot` | Reboot the remote system |