Open Tree Hole Next

Next Generation of OpenTreeHole Written In Golang

An Anonymous BBS

Features

To be done

Usage

build and run

Before building, you should have go (>=1.22) installed on your machine. If not, please visit golang.org to download the latest version.

git clone https://github.com/OpenTreeHole/treehole_next.git
cd treehole_next
# install swag and generate docs
go install github.com/swaggo/swag/cmd/swag@latest
swag init --parseDependency --parseDepth 1 # to generate the latest docs, this should be run before compiling
# build for debug
go build -o treehole.exe
# build for release
go build -tags "release" -ldflags "-s -w" -o treehole.exe
# run
./treehole.exe

Note: You should check config file to see if required environment variables are set.

test

export MODE=test
go test -v ./tests/...

benchmark

export MODE=bench
go test -v -benchmem -cpuprofile=cpu.out -benchtime=1s ./benchmarks/... -bench .

For documentation, please open http://localhost:8000/docs after running app

Badge

Powered by

Contributing

Feel free to dive in! Open an issue or Submit PRs.

We are now in rapid development, any contribution would be of great help. For the developing roadmap, please visit this issue.

Contributors

This project exists thanks to all the people who contribute.

Licence

© OpenTreeHole