Giters

MichaelAngelo13 / Docketeer

A simple interface to manage Docker resources & visualize both host and container metric data

Home Page:https://docketeer.org/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Logo

Docketeer is a developer-friendly application that provides a single interface for both container management & metric visualization.
Explore the docs »

View Demo · Report Bug · Request Feature



Table of Contents


  1. About Docketeer
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Authors

About The Project


Logo

Docketeer is an open source initiative comprising contributions from dozens of talented and passionate software engineers. Our application provides a simple interface to manage Docker resources & visualize both host and container metric data. Docketeer is a containarized application that can be deployed alongside your application cluster with hardly any effort. To learn more about our application and how to get started, keep reading!

(back to top)

Built With

ReactTypescriptReduxWebpackTailwindCSSNodeExpressGrafanaDocker

(back to top)

Getting Started

The local configuration for Docketeer was setup to be as simple as possible for the end-user. Follow the steps below to get started with Docketeer.


STEP 1 — Clone the repository

git clone https://github.com/open-source-labs/Docketeer.git

STEP 2 — Setup environment variables

Create a .env file at the top level of the project directory with the following contents:

# .env
POSTGRES_PORT=5432
POSTGRES_NAME=docketeer-db
POSTGRES_USER=postgres
POSTGRES_PASS=postgres

STEP 3 — Docker compose up

docker compose up

STEP 4 — Navigate to localhost:4000 to sign-up & login!

http://localhost:4000/

(back to top)

Usage

Coming soon...

(back to top)

Roadmap

  • Server-side integration of dockerode
  • Continued efforts to implement static typechecking using TypeScript throughout source code
  • Create additional tests to validate existing client-side & server-side functionality
    • Unit tests
    • Integration tests
    • End-to-end tests

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repository and create a pull request. You can also simply open an issue describing your contribution. Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Checkout Development (git checkout development)
  3. Create your Feature Branch (git checkout -b feature/NewFeatureName)
  4. Commit your Changes (git commit -m 'Add some NewFeatureMessage')
  5. Push to the Branch (git push origin feature/NewFeatureName)
  6. Open a Pull Request (from feature/NewFeatureName to development)
  7. Create an issue on GitHub (as mentioned above!)

Read our contributing guide for more information on how to purpose bugfixes and improvements to Docketeer.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Authors

(back to top)

Show your support

Give a ⭐️ if this project helped you!

About

A simple interface to manage Docker resources & visualize both host and container metric data

https://docketeer.org/

License:MIT License

Languages

Language:TypeScript 74.8%Language:JavaScript 23.8%Language:HTML 0.6%Language:Dockerfile 0.5%Language:CSS 0.3%