tren/README.md
ngn c69aa1e294
remove gpl3 image
Signed-off-by: ngn <ngn@ngn.tf>
2025-04-05 10:05:13 +03:00

29 lines
809 B
Markdown

# [tren](https://tren.ngn.tf) - frontend for tureng.com
![](https://git.ngn.tf/ngn/tren/actions/workflows/build.yml/badge.svg)
privacy and freedom respecting web frontend for tureng.com, written in Go
### running with docker
following command with start the web application on port 8080:
```bash
docker run -d -p 8080:8080 git.ngn.tf/ngn/tren:latest
```
repository also contains an [example compose file](compose.example.yml), which you can copy
to run the application with docker-compose
### building from source
in other to build from source, you'll need the following programs:
- git
- GNU make
- go
- sassc
after installing these programs, run the following commands to clone the repository and build
the web application from the source
```bash
git clone https://git.ngn.tf/ngn/tren
cd tren
make
```