@kearisp/workspace

Workspace

Docker workspace for web projects

Requirements

• node.js
• docker

Usage

Installation

npm i -g @kearisp/workspace

Project initialization

127.0.0.1 <domain>

cd /project-dir
ws init
ws domain:add <domain>

Starting project container

ws start -d

Options:

• --detach, -d -

Proxy

ws proxy:start

Logs

ws proxy:logs

Mariadb

Installation

To access the following services within the workspace, please add the following entries to your hosts file:

127.0.0.1 maildev.workspace
127.0.0.1 dbadmin-mariadb.workspace

Start Mariadb

ws maridb:start

Backup db

The mariadb:backup command is used to create a backup of a MariaDB database.

ws mariadb:backup [database]

Backup Location

The backup file will be saved in the following directory:

$WS_DIR/plugins/mariadb/dump/[dbname]/yyyy-MM-dd HH-mm.sql

Delete backup

The mariadb:delete-backup command will remove file from $WS_DIR directory.

ws mariadb:delete-backup [database] [filename]

Dump

The mariadb:dump command is used to dump a MariaDB database to a file.

ws mairadb:dump [database] > dump.sql

Technologies

• typescript
• dockerode

Environments

You can add WS_DIR into .bashrc for changing ws data path.

export WS_DIR="$HOME/.workspace"

Completion

source <(ws completion script)

Folders structure

├── bin/
├── plugins/
│   ├── localtunnel/
│   ├── maildev/
│   ├── mariadb/
│   └── ngrok/
├── presets/
│   ├── apache/
│   ├── go/
│   ├── node/
│   └── shopify/
├── plugins/
└── src/
    ├── makes/
    │   └── index.ts
    ├── models/
    │   └── index.ts
    ├── types/
    │   └── index.ts
    ├── utils/
    │   └── index.ts
    ├── App.ts
    ├── env.ts
    └── index.ts