OpenMetadata/README.md

67 lines
2.6 KiB
Markdown
Raw Normal View History

2021-08-01 14:27:44 -07:00
<div align="center">
<img src="https://i.imgur.com/5VumwFS.png" align="center" alt="OpenMetadata" height="90"/>
<hr />
2021-08-13 15:55:03 +05:30
[![Build Status](https://github.com/open-metadata/OpenMetadata/actions/workflows/maven-build.yml/badge.svg?event=push)](https://github.com/open-metadata/OpenMetadata/actions/workflows/maven-build.yml)
[![Release](https://img.shields.io/github/release/open-metadata/OpenMetadata/all.svg)](https://github.com/open-metadata/OpenMetadata/releases)
2021-08-01 14:27:44 -07:00
[![Twitter Follow](https://img.shields.io/twitter/follow/open_metadata?style=social)](https://twitter.com/intent/follow?screen_name=open_metadata)
2021-08-08 17:41:30 -07:00
<a href="https://join.slack.com/t/openmetadata/shared_invite/zt-oiq9s1qd-dHHvw4xjpnoRV1QQrq6vUg"><img src="https://img.shields.io/badge/slack-join-E01E5A?logo=slack" alt="Join us on Slack" height="22"/></a>
2021-08-13 15:55:03 +05:30
[![License](https://img.shields.io/github/license/open-metadata/OpenMetadata.svg)](LICENSE)
2021-08-01 14:27:44 -07:00
</div>
- [What is OpenMetadata?](#what-is-openmetadata )
2021-08-08 17:41:30 -07:00
- [Install & Run](#install-and-run)
2021-08-01 14:27:44 -07:00
- [Features](#features)
- [Building OpenMetadata](#building-openmetadata)
- [Running OpenMetadata via Docker](#running-openmetadata-via-docker)
- [Documentation](#documentation)
- [License](#license)
# What is OpenMetadata?
[OpenMetadata](https://open-metadata.org/) is a ...
2021-08-08 17:41:30 -07:00
## Our Mission
2021-08-01 14:27:44 -07:00
2021-08-08 17:41:30 -07:00
## Run OpenMetadata
Get up and running in few mins
2021-08-01 14:27:44 -07:00
2021-08-08 17:41:30 -07:00
```sh
git clone https://github.com/open-metadata/OpenMetadata
cd openmetadata/docker
docker-compose up -d
2021-08-01 14:27:44 -07:00
```
2021-08-08 17:41:30 -07:00
Then visit [http://localhost:8585](http://localhost:8585)
2021-08-01 14:27:44 -07:00
2021-08-08 17:41:30 -07:00
## Try Metadata
2021-08-01 14:27:44 -07:00
2021-08-08 17:41:30 -07:00
Visit our demo at [http://demo.open-metadata.org](http://demo.open-metadata.org)
2021-08-01 14:27:44 -07:00
2021-08-08 17:41:30 -07:00
## Features
## Documentation and Support
2021-08-01 14:27:44 -07:00
Check out [OpenMetadata documentation](https://docs.open-metadata.org/) for a complete description of OpenMetadata's features.
2021-08-08 17:41:30 -07:00
Join [our Slack Community](https://join.slack.com/t/openmetadata/shared_invite/) if you get stuck, want to chat, or are thinking of a new feature.
Or email us at [dev@open-metadata.org](mailto:dev@open-metadata.org)
We're here to help - and make OpenMetadata even better!
## Contributors
We ❤️ all contributions, big and small!
Read [Build Code and Run Tests](https://docs.open-metadata.org/open-source-community/developer/build-code-run-tests) for how to setup your local development environment.
If you want to, you can reach out via [Slack](https://join.slack.com/t/openmetadata/shared_invite/) or [email](mailto:dev@open-metadata.org) and we'll set up a pair programming session to get you started.
2021-08-01 14:27:44 -07:00
## License
OpenMetadata is under [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)