piyushxcoder
/
lupt
mirror of https://github.com/PiyushXCoder/lupt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated README.md

This commit is contained in:
Rajnish Mishra 2021-05-12 23:13:43 +05:30
parent 274b06b3eb
commit 11db6b46e6
1 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -3,4 +3,30 @@
# Lupt Chat
Chat app to talk in group or to strangers
export SALT as environment variable to use as salt for hashing.
## Running
Export SALT as environment variable to use as salt for hashing, and TENOR_API_KEY for gifs support in the server.
```
SALT="<salt>" TENOR_API_KEY="API-KEY" lupt --bind_address <interface address>:<port> --static_path <static files dir>
```
Example:
```
SALT="sometext" TENOR_API_KEY="API-KEY" lupt --bind_address 0.0.0.0:8080 --static_path ./static
```
## Building
Make sure the rust toolchain is installed. (If not, install using [rustup.rs](https://rustup.rs/))
Then, just use cargo to build the project binary
```
cargo build --release
```
This will produce the required project binary `lupt` in `target/release/lupt`
## License
This project is under (GPL License)(LICENSE)