https://github.com/longor1996/orlytalk

An online communication system written in Rust and TypeScript.
https://github.com/longor1996/orlytalk

chat chat-server docker parcel-bundler react reactjs rust rust-lang server typescript warp websockets

Last synced: about 2 months ago
JSON representation

An online communication system written in Rust and TypeScript.

• Host: GitHub
• URL: https://github.com/longor1996/orlytalk
• Owner: Longor1996
• License: mit
• Created: 2020-04-10T22:02:04.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T20:29:13.000Z (over 3 years ago)
• Last Synced: 2025-10-09T12:33:48.460Z (9 months ago)
• Topics: chat, chat-server, docker, parcel-bundler, react, reactjs, rust, rust-lang, server, typescript, warp, websockets
• Language: Rust
• Homepage:
• Size: 829 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![GitHub license](https://img.shields.io/github/license/Longor1996/orlytalk.svg)](https://github.com/Longor1996/orlytalk/blob/master/LICENSE) ![Open Issues](https://img.shields.io/github/issues/Longor1996/orlytalk) ![Build Docker Image](https://github.com/Longor1996/orlytalk/workflows/Build%20Docker%20Image/badge.svg)

# O'Rly Talk

Under construction!

## Running

Once compiled/downloaded, run `orlytalk-server` and connect to the now running webapp trough a browser of your choice.

### Environment Variables

Environment variables can be easely applied locally by writing them into a [`.env`-file](https://github.com/dotenv-rs/dotenv#readme) in the current working directory or any of its parents.

Following is a table of all environment variables OrlyTalk will fetch and their defaults:

| Env-Var | Default | Description |

|---------|---------------|-------------|

| `ORLYTALK_SQLITE_FILE` | `db.sqlite` | The name/path to the SQLite file the server should use for persistence. |

| `ORLYTALK_HOST` | `0.0.0.0` | The host address the server should bind itself to. |

| `ORLYTALK_PORT` | `6991` | The port the server should bind itself to. |

## Building

**Dependencies** are as follows:

- [Git](https://git-scm.com/).

- A recent version of rust (`1.46` or greater).

  - Download/Install [rustup](https://rustup.rs/).

- A recent version of the parcel bundler.

  - If you have NPM installed, just run `npm install -g parcel-bundler`.

- At least 1 GB of space on the drive you cloned the project to.

  - Rust and NPM cache *a lot* of stuff to make builds fast.

Then to build the project:

1. Open a console/terminal in the project directory.

2. Run `npm update`.

3. Run `npm run build`.

4. Run `cargo build`.

5. Done.

## Docker

To build and run O'Rly Talk for Docker on Linux-based systems, run the following commands:

```

docker build . -t orlytalk

docker run -p 6991:6991 orlytalk

```

You can then open [localhost:6991](http://localhost:6991) in your browser of choice.