This repository has been archived by the owner on Sep 23, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7834d04
commit 7ea5e48
Showing
2 changed files
with
26 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,47 +1,66 @@ | ||
# How to contribute | ||
|
||
The Talk project has been split into two repositories: [talk](https://github.com/proxoar/talk.git) and [talk-web](https://github.com/proxoar/talk-web.git). | ||
The Talk project has been split into two repositories: [talk](https://github.com/proxoar/talk.git) | ||
and [talk-web](https://github.com/proxoar/talk-web.git). | ||
|
||
In the process of building, the backend incorporates static site files and produces a standalone executable binary that | ||
operates independently without any external dependencies. | ||
|
||
## Clone projects | ||
|
||
```shell | ||
git clone https://github.com/proxoar/talk.git proxoar/talk | ||
git clone https://github.com/proxoar/talk-web.git proxoar/talk-web | ||
``` | ||
|
||
## Run | ||
|
||
### Backend | ||
I. Install [Go](https://go.dev/dl/) v1.21 or higher | ||
|
||
II. Start the backend server(prepare your [`talk.yaml`](README.md/#how-to-use) before starting) | ||
I. Install [Go](https://go.dev/dl/) v1.21 or higher | ||
|
||
II. Start the backend server | ||
(prepare your [`talk.yaml`](README.md/#how-to-use) before starting) | ||
```shell | ||
# in proxoar/talk | ||
make run | ||
``` | ||
The backend server listens on `localhost:8000` | ||
|
||
### Frontend | ||
I. Install [Node](https://nodejs.org/en/download/current) v20 or higher | ||
The backend server listens on `localhost:8000` | ||
|
||
### Frontend | ||
|
||
I. Install [Node](https://nodejs.org/en/download/current) v20 or higher | ||
|
||
II. Install yarn | ||
|
||
```shell | ||
npm install --global yarn | ||
``` | ||
|
||
III. Start the WEB | ||
|
||
```shell | ||
# in proxoar/talk-web | ||
yarn dev | ||
``` | ||
|
||
Open http://localhost:5173 in browser, you should see the home page. | ||
|
||
## Build a single binary | ||
|
||
I. Build the static site and copy it to `proxoar/talk` | ||
|
||
```shell | ||
# in proxoar/talk-web | ||
make copy | ||
``` | ||
|
||
II. Build backend | ||
|
||
```shell | ||
# in proxoar/talk | ||
make build | ||
``` | ||
|
||
An executive binary `talk` will be created |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters