From 5381204a3822c14fc61050cd91deeecafb050f0d Mon Sep 17 00:00:00 2001 From: Michael Kimberlin Date: Thu, 13 Mar 2025 10:49:24 -0500 Subject: [PATCH] Updated the README to reflect current state --- README.md | 77 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 58 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 0bf3e4b6db..7f85950d10 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,77 @@ -[![Gradle Build & Deploy - Develop](https://github.com/objectcomputing/check-ins/actions/workflows/gradle-build-develop.yml/badge.svg)](https://github.com/objectcomputing/check-ins/actions/workflows/gradle-build-develop.yml) +# Check-Ins + +Check-Ins is a team engagement platform with [many HRIS and engagement capabilities](#features) built on +[Micronaut](https://micronaut.io/) and [React](https://react.dev/) and available for deployment on premises or on +[Google Cloud Platform](https://cloud.google.com/). + +[![Gradle Build & Deploy - Develop](https://github.com/objectcomputing/check-ins/actions/workflows/gradle-deploy-develop.yml/badge.svg)](https://github.com/objectcomputing/check-ins/actions/workflows/gradle-deploy-develop.yml) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md) +[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +## Table of Contents -- [Check-ins](#check-ins) -- [Project Links](#project-links) -- [Setup](#setup) - - [directory.json](#directoryjson) - - [credentials.json](#credentialsjson) - - [Running the application](#running-the-application) +- [About](#about) +- [Features](#features) +- [Documentation](#documentation) +- [Getting Started](#getting-started) + - [Environment Setup](#environment-setup) + - [Running the Application](#running-the-application) + - [Troubleshooting](#troubleshooting) - [Contributing](#contributing) - +- [License](#license) +- [Contact](#contact) -# Check-ins +## About + +Check-Ins is a comprehensive web application designed to streamline team management and personal development. It offers +tools for understanding team members and their capabilities, facilitating growth and engagement, and managing many of +the processes that can get dropped or weigh down an organization. Built with Micronaut, Check-Ins is designed for +efficient cost of operation and ease of use. Many of the workflows were originally designed and built by former interns +at [Object Computing](https://objectcomputing.com), and we use it actively there today. + +## Features -This web application is written in [Micronaut](https://micronaut.io) for uploading files and tracking skill set of team members. This application will also be used for PDL checkins and to auto-generate resumes from the skill set. +- **User/Employee Management** - Simple onboarding and offboarding of new users, with Google SSO integration +- **Employee Profiles** - Team members can manage their own profiles, including skills, certifications, and organizations they support +- **Mentor Program Management** - A key feature of the Check-Ins application is the support and management of employee touch points with a dedicated mentor +- **Pulse Surveys** - Find out how your team is feeling about work, or life in general +- **Feedback Management** - Give your employees access to feedback so that they can grow their skills and contribute up to their potential +- **Employee, Team, and Community Directories** - These provide an easy way to see who is involved with what +- **Performance Reviews and Reporting** - Evaluate your team's performance as frequently as you would like +- **Public Kudos** - Celebrate those wins publicly! Our Kudos feature can post your team's wins to Slack and celebrate them within the application. +- **Birthday and Anniversary Celebrations** - Encourage the celebration of your team's milestones +- **Skill and Certification Tracking and Reporting** - Know where your team is strong, where it needs to develop, and plan for growth +- **Volunteer Time Tracking and Reporting** - Encourage a culture of giving back to your community by recognizing the good work already being done by your team -# Project Links +## Documentation -**Project Document:** \*TBA\* +Detailed documentation, including installation guides, usage instructions, and API references, can be found on our [GitHub Pages site](https://objectcomputing.github.io/check-ins/). -**Project Board:** [Board](https://github.com/objectcomputing/check-ins/projects) +## Getting Started -**Environments:** \*TBA\* +### Environment setup -# Environment setup +See [our GitHub pages site](https://objectcomputing.github.io/check-ins/getting-started/setup/) for instructions on setting up your development environment. -See [Setting up your environment](https://objectcomputing.github.io/check-ins/getting-started/setup/) for instructions on setting up your development environment. +### Running the application -## Running the application +See [our GitHub pages site](https://objectcomputing.github.io/check-ins/getting-started/running/) for instructions on running the application locally. -See [Running the Application](https://objectcomputing.github.io/check-ins/getting-started/running/) for instructions on running the application locally. +### Troubleshooting -# Contributing +See [our GitHub pages site](https://objectcomputing.github.io/check-ins/getting-started/troubleshooting/) for common challenges and their solutions. + +## Contributing Please see [Contributing](./CONTRIBUTING.md) for details on how to contribute to this project. + +## License + +This project is licensed under the [Apache 2.0 License and Commons Clause](LICENSE). + +## Contact + +For questions or issues, please [join the discussion](https://github.com/objectcomputing/check-ins/discussions) or +[open an issue](https://github.com/objectcomputing/check-ins/issues) on GitHub.