Breezed

Breezed is a CLI tool to quickly spin up and manage remote VPSes.

Structure

Breezed has two main parts:

• Server: Provides an API for creating and managing Breezed containers, which are modified debian slim containers, with ssh server pre-installed and set up.

• Client: CLI tool for interacting with the API. Allows you to quickly spin up Breeze dcontainers and manage them.

Installation (client)

git clone https://github.com/Charmunks/Breezed
cd client
npm i
npm link

Deploying (server)

git clone https://github.com/Charmunks/Breezed
cd server
cp .env.example .env # Fill out the .env
npm install
npx knex migrate:latest
npm run dev # Or npm run start for prod

Tech Stack

• ExpressJS backend (/server)
• Javascript CLI, distrubuted using NPM (/client)
• Postgres database using knex.js
• Actual VPSs are docker images (/utils/containers.util.js)

Filesystem

Server (/server)

• All route files in /routes
• All util files in /utils
• Docker container being used is in /container/Dockerfile
• Database migrations in /migrations
• All middleware in /middleware

Client (/client)

• Main script in cli.js
• Commands in /commands
• Utils in /utils