Skip to content

Commit

Permalink
Merge pull request #1 from TShentu/doc/update-readme
Browse files Browse the repository at this point in the history
doc. Update Repo Readme
  • Loading branch information
pengpeng authored May 21, 2024
2 parents ca64d21 + cdd7ee2 commit a125174
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,22 @@
# market
# Market
![Market](https://docs.jointerminus.com/images/how-to/terminus/market/discover.jpg)

## Description
**market** is a component of **Terminus OS** based on **app-service** and **market-server**, principally tasked with managing the installation, upgrade, and uninstallation of Application, Model, and Recommend among other related operations.
The **Market** is a built-in application of **Terminus OS**. It's an implementation of the decentralized and permissionless [Open Application Distribution Protocol](https://docs.jointerminus.com/overview/protocol/market.html).

The **Application** is a Custom Resource (CR) defined by k8s Custom Resource Definition (CRD). When a user initiates an installation, it is automatically created by the Application Controller.
With Market, you can one-click install various apps, recommendation algorithms, and large language models from Terminus and third-party developers.

## Overview
**Market** is built on **app-service** and **market-server**. Its primary role is to manage the installation, upgrade, and uninstallation of Apps, Models, and Recommendations, among other related operations.

The **Application** in Terminus is a Custom Resource (CR) defined by the k8s Custom Resource Definition (CRD). When a user initiates an installation, it's automatically created by the Application Controller.

## Getting Started
You’ll need a Kubernetes cluster to run against. You’ll need market running on the Kubernetes cluster. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster.
If you want to use Terminus, there's no need to run this service separately. Just install Terminus, and it will be included in the system.

Alternatively, if you want to run a standalone Market instance, please refer to the installation guide below.

## How to install
To run Market, you'll need a Kubernetes cluster. You can use [KIND](https://sigs.k8s.io/kind) for a local testing cluster, or use a remote cluster.

### Build backend
1. Build and push your image to the location specified by `IMG`:
Expand All @@ -15,4 +25,4 @@ You’ll need a Kubernetes cluster to run against. You’ll need market running
make docker-build docker-push IMG=<some-registry>/market-backend:tag
```
### Build frontend
[frontend](./frontend/README.md)
Please refer to [frontend](./frontend/README.md)

0 comments on commit a125174

Please sign in to comment.