Skip to content

Commit

Permalink
docs: 📝 update docs with info about env variables and add links
Browse files Browse the repository at this point in the history
  • Loading branch information
nirjan-dev committed Dec 16, 2024
1 parent cab6909 commit b87a2d8
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 4 deletions.
9 changes: 9 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Cloudflare TURN
# https://developers.cloudflare.com/calls/turn/generate-credentials/

NUXT_TURN_ID=
NUXT_TURN_TOKEN=

# Optional
# https://telemetrydeck.com/docs/guides/javascript-setup/
NUXT_PUBLIC_TELEMETRYDECK_APP_ID=
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,14 @@ To get started, clone the repository and install the dependencies:
pnpm install
```

create a .env file by copying the example env file

```bash
cp .env.example .env
```

- You need to use [Cloudflare Turn](https://developers.cloudflare.com/calls/turn/generate-credentials/) to make the WebRTC connection work for clients on a different network.

Then, start the development server:

```bash
Expand Down Expand Up @@ -66,10 +74,10 @@ Litsi Chat is licensed under the MIT License.
## Acknowledgements
This project uses the following dependencies:

- [Nuxt.js]()
- [Simple Peer]()
- [Vue.js]()
- [Nuxt.js](https://nuxt.com/)
- [Simple Peer](https://github.com/feross/simple-peer)
- [Vue.js](https://vuejs.org/)


## Author
[Nirjan Khadka]()
[Nirjan Khadka](https://github.com/nirjan-dev/)

0 comments on commit b87a2d8

Please sign in to comment.