diff --git a/README.md b/README.md index 5a5069d..8cf531d 100644 --- a/README.md +++ b/README.md @@ -50,110 +50,38 @@ ## Architecture -casibase contains 4 parts: +Casibase contains 2 parts: | **Name** | **Description** | **Language** | |----------------|---------------------------------------------------|-----------------------------------------| -| Frontend | User interface for the casibase application | JavaScript + React | -| Backend | Server-side logic and API for casibase | Golang + Beego + Python + Flask + MySQL | -| AI Model | Artificial intelligence model | Python + OpenAI | -| Knowledge Base | Storage for casibase application domain knowledge | pgvector | +| Frontend | User interface for Casibase | JavaScript + React | +| Backend | Server-side logic and API for Casibase | Golang + Beego + Python + Flask + MySQL | ![0-Architecture-casibase](assets/0-Architecture-casibase.png) -## Demo Installation +## Online Demo -casibase uses Casdoor to manage members. So you need to create an organization and an application for casibase in a Casdoor instance. + -### Casdoor configuration +## Documentation -```shell -git clone https://github.com/casdoor/casdoor.git -``` + -refer to: https://casdoor.org/docs/basic/server-installation +## Install -Follow these steps to setup Casdoor for casibase: + -- Create an **Organization**![1-Add-organization](assets/1-Add-organization.png) +## How to contact? -- Configure information about the **Organization**![2-Configure-information-organization](assets/2-Configure-information-organization.png) +Discord: -- Add a member to a newly created organization![3-Check-user](assets/3-Check-user.png)![4-Add-member-to-organization](assets/4-Add-member-to-organization.png) +Forum: -- Configure member information (remember its **Name** as well as **Password**)![5-Configure-new-user](assets/5-Configure-new-user.png) +Contact: + +## Contribute +For Casibase, 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). - -- Create a new **Application**![6-Add-application](assets/6-Add-application.png) - -- Configuring **Application** Information (Remember **Name, ClientID** and **ClientSecret**. Change **RedirectURLs** to http://localhost:14000/callback) ![7-Configure-new-application](assets/7-Configure-new-application.png) - -### casibase configuration - -#### Get the code - -```shell -git clone https://github.com/casbin/casibase.git -``` - -#### Setup database - -casibase will store its users, nodes and topics informations in a MySQL database named: `casibase`, will create it if not existed. The DB connection string can be specified at: https://github.com/casbin/casibase/blob/master/conf/app.conf - -```ini -dataSourceName = root:123@tcp(localhost:3306)/ -``` - -Casnode uses XORM to connect to DB, so all DBs supported by XORM can also be used. - -#### Custom config - -- #### Backend (`casibase\conf\app.conf`) - - ```ini - casdoorEndpoint = - clientId = - clientSecret = - casdoorOrganization = "casibase" - casdoorApplication = "app-casibase" - ``` - -- #### Frontend (`casibase\web\src\Conf.js`) - - ```ini - export const AuthConfig = { - ...... - clientId: , - ...... - }; - ``` - -#### Run casnode - - - #### Backend (`casibase`) - - ```shell - go run main.go - ``` - - - #### Frontend (`casibase\web`) - - ```shell - yarn install - yarn start - ``` - -#### Preview - -Access the login view via the following link: - -```shell -http://localhost:13001 -``` - -![8-Preview-base-wordsets](assets/8-Preview-base-wordsets.png) - -![9-Preview-casibase-stores](assets/9-Preview-casibase-stores.png) - -The **casibase** demo is shown above, and in the future users can upload various **knowledge** files, **wordsets**, and **factorsets** to achieve a **customized domain knowledge base**. +## License +[Apache-2.0](https://github.com/casbin/casibase/blob/master/LICENSE) diff --git a/assets/1-Add-organization.png b/assets/1-Add-organization.png deleted file mode 100644 index 77dc405..0000000 Binary files a/assets/1-Add-organization.png and /dev/null differ diff --git a/assets/2-Configure-information-organization.png b/assets/2-Configure-information-organization.png deleted file mode 100644 index 85acf85..0000000 Binary files a/assets/2-Configure-information-organization.png and /dev/null differ diff --git a/assets/3-Check-user.png b/assets/3-Check-user.png deleted file mode 100644 index c1e421b..0000000 Binary files a/assets/3-Check-user.png and /dev/null differ diff --git a/assets/4-Add-member-to-organization.png b/assets/4-Add-member-to-organization.png deleted file mode 100644 index 1800da8..0000000 Binary files a/assets/4-Add-member-to-organization.png and /dev/null differ diff --git a/assets/5-Configure-new-user.png b/assets/5-Configure-new-user.png deleted file mode 100644 index b3c0e80..0000000 Binary files a/assets/5-Configure-new-user.png and /dev/null differ diff --git a/assets/6-Add-application.png b/assets/6-Add-application.png deleted file mode 100644 index 7d39647..0000000 Binary files a/assets/6-Add-application.png and /dev/null differ diff --git a/assets/7-Configure-new-application.png b/assets/7-Configure-new-application.png deleted file mode 100644 index b3ba73e..0000000 Binary files a/assets/7-Configure-new-application.png and /dev/null differ diff --git a/assets/8-Preview-base-wordsets.png b/assets/8-Preview-base-wordsets.png deleted file mode 100644 index 45373a5..0000000 Binary files a/assets/8-Preview-base-wordsets.png and /dev/null differ diff --git a/assets/9-Preview-casibase-stores.png b/assets/9-Preview-casibase-stores.png deleted file mode 100644 index 6c25565..0000000 Binary files a/assets/9-Preview-casibase-stores.png and /dev/null differ