# Flatboat

*This repository is part of the [Flatboat Project](https://github.com/JuanCSUCoder/FlatBoatProject)*

![Logo](https://github.com/JuanCSUCoder/flatboat-brand/blob/main/logo.png?raw=true)

Flatboat is a CLI tool that integrates **Docker** and **Kubernetes** tooling into the **ROS workspace** workflow.

![GitHub License](https://img.shields.io/github/license/JuanCSUCoder/flatboat-cli?style=for-the-badge)

## Features

- **Automatic** container lifecycle management
- **Create ROS workspaces** from devcontainer templates
- **Execute ROS2 commands** inside the container
- **Execute shell commands** inside the container
- Out-of-the-box graphical user interface **GUI support**
- Out-of-the-box **GPU support**
- Out-of-the-box workspace **volume binding**
- Out-of-the-box **host network** connectivity
- Out-of-the-box **avahi service** for .local domain resolution
- Compatible with **Devcontainer Specification**

## Compatibility

Compatible with **Linux** distributions capable of running **Docker** with **X11** window system and **avahi daemon**.

**NOTE:** Linux distros with different configurations may be able to run flatboat with a few workarounds.

## Installation

### Dependencies

- Docker [Installation](https://docs.docker.com/engine/install/)
- NodeJS [Official Download](https://nodejs.org/en) or [Installation with NodeSource](https://github.com/nodesource/distributions?tab=readme-ov-file#debian-and-ubuntu-based-distributions)
- Devcontainer `npm i -g @devcontainers/cli`
- Rust and Cargo `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`

### Install

Install Flatboat with `cargo`

```bash
  cargo install flatboat
```

## Usage

Learn about Flatboat with:

```bash
  flatboat -h
```

## Authors

- [@JuanCSUCoder - Juan Camilo Sánchez Urrego](https://www.github.com/JuanCSUCoder) - <juancsucoder@gmail.com>

## Roadmap

1. Templates
    1. Package Dockerfile
    2. Kubernetes Workers
    3. Kubernetes Master
2. Integration of Templates
3. Local Kubernetes Driver

## License

> Copyright 2024 Juan Camilo Sánchez Urrego @JuanCSUCoder <juancsucoder@gmail.com>
>
> Licensed under the Apache License, Version 2.0 (the "License");
> you may not use this file except in compliance with the License.
> You may obtain a copy of the License at:
>
> <http://www.apache.org/licenses/LICENSE-2.0>
>
> Unless required by applicable law or agreed to in writing, software
> distributed under the License is distributed on an "AS IS" BASIS,
> WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
> See the License for the specific language governing permissions and
> limitations under the License.