Skip to content

Latest commit

 

History

History

keep-ui

Keep UI

Background

Keep UI is a user interface platform designed to manage and configure providers for an application. It allows users to connect and disconnect various providers, such as Grafana and Datadog, and configure their authentication settings. The platform provides a user-friendly interface to facilitate the management of provider connections.

How to Start

To start using Keep UI, follow the steps below:

  1. Clone the repository from GitHub.
  2. Install the necessary dependencies by running npm install or yarn install.
  3. Configure the environment variables required for the application. Refer to the documentation for the specific environment variables needed.
  4. Start the development server using npm run dev or yarn dev.
  5. Access the Keep UI application in your browser at http://localhost:3000 (or the specified port).

How to Contribute

Contributions to Keep UI are welcome and encouraged. To contribute to the project, please follow these guidelines:

  1. Fork the repository on GitHub.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes in the branch, ensuring to adhere to the coding style and guidelines.
  4. Write unit tests for new features or modifications, if applicable.
  5. Commit your changes and push them to your forked repository.
  6. Submit a pull request to the main repository, describing the changes and providing any additional relevant information.
  7. Participate in the code review process and address any feedback or comments received.
  8. Once approved, your changes will be merged into the main codebase.

Please ensure that your contributions align with the project's coding standards, documentation guidelines, and overall goals. For major changes or new features, it is advisable to discuss them with the project maintainers or open an issue to gather feedback and ensure they align with the project roadmap.

License

Keep UI is released under the MIT License.