initial commit
All checks were successful
Build and publish the docker image / build (push) Successful in 58s
All checks were successful
Build and publish the docker image / build (push) Successful in 58s
Signed-off-by: ngn <ngn@ngn.tf>
This commit is contained in:
30
README.md
Normal file
30
README.md
Normal file
@ -0,0 +1,30 @@
|
||||
# [tren](https://tren.ngn.tf) - frontend for tureng.com
|
||||
|
||||

|
||||
|
||||
tren is a simple 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
|
||||
```
|
||||
|
||||
![https://www.gnu.org/graphics/gplv3-with-text-136x68.png]()
|
Reference in New Issue
Block a user