Appendix

What is Dockter
Prerequisites
Quick Start
Built With
Contributions
Testing
Authors
Beta

What is Dockter?

Dockter v0.1.0 is a low-overhead , open source Docker log management tool built for:

• Real-time Log Collection - communicating with the Docker Engine API to access container streams and collect live logs

• Log Aggregation - Storing container logs into a centralized database

• Filter & Search Capability - Analyze and extract meaningful data through filter and search

Prerequisites

Ensure that you have the following installed and running on your machine:

• Docker Client
• Running Docker Container(s)
• MongoDB
• Yarn Package Manager

Quick Start

First, clone our repo by running either:

git clone [email protected]:oslabs-beta/Dockter.git

or

gh repo clone oslabs-beta/Dockter

(if you have the Github CLI installed) in your terminal. Next, cd into your cloned Docktor repository and run the following command to install all necessary dependencies

yarn

Last, run this command to start Dockter on your machine. It's as easy as that!

yarn start

Built With

• Docker - Platform as a Service
• React (Hooks) - Front-end Library
• Electron - Desktop Application Framework
• Tailwind CSS
• MongoDB - noSQL Document Oriented database
• Mongoose - Object Data Modeling Library
• Jest - Testing Framework
• Enzyme - React Testing Utility
• ESlint - Javascript Linting Tool
• Yarn - Package Manager

Contributions

Dockter welcomes any ideas and/or contributions to its codebase. Please click the button below to reach out to us at with any questions or even if you'd just like to talk shop. We'd love to hear from you!

> To run the application in development mode, please clone the Docktor repository to your local machine and run the following commands in your terminal:

yarn

yarn dev

Testing

To perform tests on the Dockter codebase, please clone the repository to your local machine and run the following commands in your terminal:

yarn

yarn build

yarn test

Authors

Benjamin Brower @github @linkedIn
Anup Ramdass @github @linkedIn
Nancy Koushoult @github @linkedIn
Kyle Whang @github @linkedIn
Samuel Kim @github @linkedIn

Features In Beta

The Dockter team is dedicated to working around the clock to ensure proper maintainence and the addition of even more robust features. The following are coming soon:

• Analysis of Log Metrics - real-time log statistics will be available to the user on the Dockter dashboard in a visualized format with the capability to dynamically focus on logs that may require higher levels of oversight
• Container management - users will be able to remove, stop, and start containers from within the Dockter dashboard