Skip to content

Commit

Permalink
docs: Update README.md and Biome schema version
Browse files Browse the repository at this point in the history
  • Loading branch information
angelmadames committed Apr 1, 2024
1 parent d824578 commit bd80f4d
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 11 deletions.
81 changes: 71 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,88 @@
<!-- omit in toc -->
# DEMS - CLI
# Development Environment Management System (DEMS)

[![🧪 Tests](https://github.com/angelmadames/dems-cli/actions/workflows/tests.yml/badge.svg)](https://github.com/angelmadames/dems-cli/actions/workflows/tests.yml)

<!-- omit in toc -->
## Contents

- [Overview](#overview)
- [Setup](#setup)
- [🗒️ Overview](#️-overview)
- [🔧 Setup](#-setup)
- [🖍️ Style](#️-style)
- [🏗️ Structure](#️-structure)
- [🟢 Commands](#-commands)
- [🔵 Config](#-config)
- [🟠 Utils](#-utils)

## 🗒️ Overview

## Overview
DEMS is a generic CLI tool meant to assist teams to quickly get from onboarding
to coding by automating the initialization process of an application (git clone,
deps install, provisioning of required services like databases or mail servers)
using Docker.

This project was created using `bun init` in bun v1.0.23.
[Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
DEMS is made with [Bun], [TypeScript] and [Commander.js].

## Setup
## 🔧 Setup

To install dependencies:

```bash
```shell
bun install
```

To run:

```bash
bun run cli.ts
```shell
./cli.ts --help
```

## 🖍️ Style

Our chosen format and lint tool is [Biome]. For more information about our
preset and custom rules configuration, see the [biome.json](./biome.json)
file.

## 🏗️ Structure

The current version of DEMS in this repository is a modern adaptation of an internal
tool with the same name that I made for [gbh.tech]. The original version was made
purely with Bash scripts, which is the main motivation for this newer version, to
extend its capabilities with a rich ecosystem and make it more accesible to developers.

The structure of DEMS is simple: it has **commands** ([/src/commands](./src//commands/)),
and those commands depend on **utilities** ([/src/utils](./src/utils/)) and **config
files** ([/src/config](./src/config/)).

### 🟢 Commands

As you'd expect, `commands` are the protagonists of DEMS. They assist the software engineer
in the various tasks needed to setup a local project and start working on it.

Commands are instances of the Command class provided by [Commander.js], which are then
added to the main `cli` Command object in the [./cli.ts](./cli.ts) file with `addCommand()`.

> 💡 Execute `dems --help` to check all available commands.
### 🔵 Config

The DEMS Config is split into three (3) different contexts found in two different files: [./src/config/cli.ts](./src/config//cli.ts) and [./src/config/dems.ts](./src/config//dems.ts).

- **CLI**: modifies the behavior of the CLI tool, without affecting any specific project.
- **DEMS**: defines the configuration directives of DEMS for every project, in the form of a `config.json` file.
- **Environment**: defines the blogal environment variables of DEMS that can affect all other configurations (all env vars start with a prefix `DEMS_` to avoid conflicts).

### 🟠 Utils

The Utils are simply re-usable functions that assist commands, they can go from simple things
like normalizing a string, to more complex tags like generating a .env file from the config.json
of the project or generating parameter for Docker Compose.

For more information, check the [./src/utils](./src//utils/) directory.

<!-- References -->
[Bun]: https://bun.sh
[TypeScript]: https://www.typescriptlang.org
[Commander.js]: https://github.com/tj/commander.js
[Biome]: https://biomejs.dev
[gbh.tech]: https://gbh.tech
2 changes: 1 addition & 1 deletion biome.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$schema": "https://biomejs.dev/schemas/1.4.1/schema.json",
"$schema": "https://biomejs.dev/schemas/1.6.3/schema.json",
"organizeImports": {
"enabled": true
},
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "dems-cli",
"version": "0.0.1",
"description": "DEMS (Development Environment Management System) CLI",
"author": "Angel Adames <angeladames@hey.com>",
"main": "dist/cli.js",
Expand Down

0 comments on commit bd80f4d

Please sign in to comment.