https://github.com/openanime/watch-together-socket
Watch together socket server that powers watch together feature in OpenAnime
https://github.com/openanime/watch-together-socket
nodejs socketio typescript uwebsocketsjs
Last synced: about 1 year ago
JSON representation
Watch together socket server that powers watch together feature in OpenAnime
- Host: GitHub
- URL: https://github.com/openanime/watch-together-socket
- Owner: OpenAnime
- License: other
- Created: 2023-06-24T12:38:39.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-01T19:38:44.000Z (over 1 year ago)
- Last Synced: 2025-03-29T02:41:43.715Z (over 1 year ago)
- Topics: nodejs, socketio, typescript, uwebsocketsjs
- Language: TypeScript
- Homepage: https://openani.me
- Size: 2.64 MB
- Stars: 9
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
OpenAnime Watch Together Server
Watch together socket server that powers watch together feature in OpenAnime
Website
·
Report Bug
·
Request Feature
Table of Contents
## About OpenAnime
[![OpenAnime Homepage][OpenAnime-ss]](https://openani.me)
In March 2022, we founded OpenAnime with the mission of enhancing your anime viewing experience. OpenAnime boasts real-time anime upscaling powered by your GPU, a synchronized 'watch together' feature, personalized playlists, the ability to craft and share your own clips with friends, an immersive offline anime viewing experience directly in your browser, a customizable theme feature, a meticulously crafted video player, and an aesthetically pleasing user interface.
### Built With
[![Socket.io][Socket.io]][Socket.io-url]
[![TypeScript][TypeScript]][TypeScript-url]
[![Prettier][Prettier]][Prettier-url]
[![ESLint][ESLint]][ESLint-url]
[![Vite][Vite]][Vite-url]
## Getting Started
This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.
### Prerequisites
- Node.js LTS versions 16, 18 and 20 (22 support not yet implemented)
### Installation and local deployment
1. Clone the repo
```sh
git clone https://github.com/OpenAnime/watch-together-socket.git
```
2. Go into the repo directory
```sh
cd watch-together-socket
```
3. Install NPM packages
```sh
npm i
```
4. Create an .env file using .env.example
5. Run locally
```sh
npm run dev
```
## Contributing
Contributions are what make this 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/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the Business Source License 1.1. See [license file](https://github.com/OpenAnime/licenses/blob/main/BSL.txt) for more information.
## Acknowledgments
We're grateful to the inspiring projects and individuals who shaped our endeavor. Without them, our project wouldn't be what it is today.
- [@uNetworkingAB](https://github.com/uNetworkingAB)'s [uWebSockets.js](https://github.com/uNetworking/uWebSockets.js)
## Contributors
[TypeScript]: https://img.shields.io/static/v1?style=for-the-badge&message=TypeScript&color=3178C6&logo=TypeScript&logoColor=FFFFFF&label=
[TypeScript-url]: https://www.typescriptlang.org/
[Socket.io]: https://img.shields.io/static/v1?style=for-the-badge&message=Socket.io&color=010101&logo=Socket.io&logoColor=FFFFFF&label=
[Socket.io-url]: https://socket.io
[Vite]: https://img.shields.io/static/v1?style=for-the-badge&message=Vite&color=646CFF&logo=Vite&logoColor=FFFFFF&label=
[Vite-url]: https://vitejs.dev/
[Prettier]: https://img.shields.io/static/v1?style=for-the-badge&message=Prettier&color=222222&logo=Prettier&logoColor=F7B93E&label=
[Prettier-url]: https://prettier.io/
[ESLint]: https://img.shields.io/static/v1?style=for-the-badge&message=ESLint&color=4B32C3&logo=ESLint&logoColor=FFFFFF&label=
[ESLint-url]: https://eslint.org/
[OpenAnime-ss]: /website.png
