minsilo-react-client v1.4.6

OpenAlignment Web Client

OpenAlignment is the open-source upstream alignment management platform that is used by Minsilo. This project is the React client for OpenAlignment.

To use this project, you'll also need to configure the api. See instructions on the project page for the API to see how.

Easy way to get started

Minsilo maintains and sponsors this project. If you want to get started with OpenAlignment without any of the work (and use it in production), click below:

Get started without installing anything here

Screenshots

Features

OpenAlignment provides teams and organizations with the ability to:

• Set, track, manage and document goals using the OKRs framework.
  • Live document editing with built in chat. This allows you to collaboratively build a set of OKRs with other users.
• Communicate company purpose, including mission, vision, values, and more.
  • File attachments are supported with calls to the API.
  • Custom purpose types are supported.
• Communicate, track, and manage strategic initiatives. The strategy feature is primarily aimed at helping teams
  • File attachments can be attached to strategies.
  • Set custom types of strategic initiatives.
• Align goals, strategies, and purposes with each other.
• Annotate alignment between goals, strategies, and purposes.
• Many other features that will be documented in the future.

Getting Started

Setting up your development environment

Getting started with the React client is easy. To start, you'll need to:

1. Make sure you have nodejs and yarn installed on your machine.

2. Install any necessary packages using yarn install.

3. Add your local configuration.

  // src/secrets.js
  export const MixpanelToken = "mixpanel-token";
  export const BugsnagToken = "bugsnag-token";
  export const TrelloToken = "trello-api-token";

3. Start the server by running yarn start.

The React project was built using create-react-app. We currently use an unejected Webpack configuration based on CRA, so configuring it should be simple.

Contributing

We welcome contributions. Please check out our Contributors Guide for more details.

Security

If you've found a security issue, please let us know. We always welcome responsible disclosure and encourage you to share what you find confidentially.

To disclose security issues to us confidentially, please visit our responsible disclsoure page.

License & Trademark

OpenAlignment is made available under the Affero GNU General Public License.

The Minsilo name (stylized as MINSILO or Minsilo) and logomark are trademarks of Minsilo Inc. You may not use these trademarked names or symbols without express written permission by Minsilo Inc. You are also further prohibited from distributing this project with those names in it.