From f7e0a0c0e51a64297ea39b4cb45311c84d78efb6 Mon Sep 17 00:00:00 2001
From: Yang Luo <hsluoyz@qq.com>
Date: Mon, 26 Jun 2023 19:21:46 +0800
Subject: [PATCH] docs: add README.md to this repo (#8)

* Update README.md

* Update README.md

* Update README.md
---
 README.md | 99 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 98 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2db9995..12c4faf 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,98 @@
-# casvisor
\ No newline at end of file
+<h1 align="center" style="border-bottom: none;">📦⚡️ Casvisor</h1>
+<h3 align="center">An open-source logging and auditing system developed by Go and React.</h3>
+<p align="center">
+  <a href="#badge">
+    <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
+  </a>
+  <a href="https://hub.docker.com/r/casbin/casvisor">
+    <img alt="docker pull casbin/casvisor" src="https://img.shields.io/docker/pulls/casbin/casvisor.svg">
+  </a>
+  <a href="https://github.com/casbin/casvisor/releases/latest">
+    <img alt="GitHub Release" src="https://img.shields.io/github/v/release/casbin/casvisor.svg">
+  </a>
+  <a href="https://hub.docker.com/repository/docker/casbin/casvisor">
+    <img alt="Docker Image Version (latest semver)" src="https://img.shields.io/badge/Docker%20Hub-latest-brightgreen">
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://goreportcard.com/report/github.com/casbin/casvisor">
+    <img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/casbin/casvisor?style=flat-square">
+  </a>
+  <a href="https://github.com/casbin/casvisor/blob/master/LICENSE">
+    <img src="https://img.shields.io/github/license/casbin/casvisor?style=flat-square" alt="license">
+  </a>
+  <a href="https://github.com/casbin/casvisor/issues">
+    <img alt="GitHub issues" src="https://img.shields.io/github/issues/casbin/casvisor?style=flat-square">
+  </a>
+  <a href="#">
+    <img alt="GitHub stars" src="https://img.shields.io/github/stars/casbin/casvisor?style=flat-square">
+  </a>
+  <a href="https://github.com/casbin/casvisor/network">
+    <img alt="GitHub forks" src="https://img.shields.io/github/forks/casbin/casvisor?style=flat-square">
+  </a>
+</p>
+
+## Online Demo
+Deployed site: [https://log.casbin.com/](https://log.casbin.com/)
+
+## Architecture
+Casvisor contains 2 parts:
+Name | Description | Language | Source code
+----|------|----|----
+Frontend | Web frontend UI for Casvisor | Javascript + React | https://github.com/casbin/casvisor/tree/master/web
+Backend | RESTful API backend for Casvisor | Golang + Beego + MySQL | https://github.com/casbin/casvisor
+
+## Installation
+Casvisor uses Casdoor to manage members. So you need to create an organization and an application for Casvisor in a Casdoor instance.
+
+### Necessary configuration
+
+#### Get the code
+```bash
+go get github.com/casbin/casdoor
+go get github.com/casbin/casvisor
+```
+
+or
+
+```bash
+git clone https://github.com/casbin/casdoor
+git clone https://github.com/casbin/casvisor
+```
+
+#### Setup database
+
+Casvisor will store its users, nodes and topics informations in a MySQL database named: `casvisor`, will create it if not existed. The DB connection string can be specified at: https://github.com/casbin/casvisor/blob/master/conf/app.conf
+
+```ini
+dataSourceName = root:123@tcp(localhost:3306)/
+```
+Casvisor uses XORM to connect to DB, so all DBs supported by XORM can also be used.
+
+#### Configure Casdoor
+
+After creating an organization and an application for Casvisor in a Casdoor, you need to update `clientID`, `clientSecret`, `casdoorOrganization` and `casdoorApplication` in app.conf.
+
+#### Run Casvisor
+
+- Configure and run Casvisor by yourself. If you want to learn more about casvisor.
+- Open browser: http://localhost:16001/
+
+### Optional configuration
+
+#### Setup your Casvisor to enable some third-party login platform
+
+  Casvisor uses Casdoor to manage members. If you want to log in with oauth, you should see [casdoor oauth configuration](https://casdoor.org/docs/provider/OAuth).
+
+#### OSS, Mail, and SMS services
+
+  Casvisor uses Casdoor to upload files to cloud storage, send Emails and send SMSs. See Casdoor for more details.
+
+## Contribute
+
+For Casvisor, if you have any questions, you can give Issues, or you can also directly start Pull Requests(but we recommend giving issues first to communicate with the community).
+
+## License
+
+[Apache-2.0](https://github.com/casvisor/casvisor/blob/master/LICENSE)
\ No newline at end of file