CONTRIBUTING.md

How to contribute

The Talk project has been split into two repositories: talk and talk-web.

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

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 v1.21 or higher

II. Start the backend server (prepare your talk.yaml before starting)

# in proxoar/talk
make run

The backend server listens on localhost:8000

Frontend

I. Install Node v20 or higher

II. Install yarn

npm install --global yarn

III. Start the WEB

# 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

# in proxoar/talk-web
make copy

II. Build backend

# in proxoar/talk
make build

An executive binary talk will be created