GitHunt
YA

yakimenko73/sync-party-gateway

Sync-party websocket server in Elixir

Sync-party gateway

Pray for Ukraine
Licence
Deploy
Code factor

What is it?

Elixir websocket gateway for real-time Sync-party site operation

Built With

Getting Started

This tutorial will help you run server locally

Installation

Requires Elixir >= 1.13

  1. Clone the repo
git clone https://github.com/yakimenko73/sync-party-gateway.git
  1. Get project deps
mix deps.get
  1. Run in dev mode with
iex -S mix

The HTTP server is listening on port 4000 by default. The websocket endpoint is located at ws://localhost:4000/ws Connected clients are closed if inactive longer than 60s. This can be changed in config/config.exs together with port and ws_endpoint.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/amazing-feature)
  3. Commit your Changes (git commit -m 'Add some amazing-feature')
  4. Push to the Branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Contact

Languages

Elixir99.4%Dockerfile0.6%

Contributors

Created January 26, 2022
Updated June 13, 2023
yakimenko73/sync-party-gateway | GitHunt