README.md

OpenAnime Watch Together Server

Watch together socket server that powers watch together feature in OpenAnime

Website · Report Bug · Request Feature

Table of Contents

1. About OpenAnime
   • Built With
2. Getting Started
   • Prerequisites
   • Installation and local deployment
3. Contributing
4. License
5. Acknowledgments
6. Contributors

About OpenAnime

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.

(back to top)

Built With

(back to top)

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

   git clone https://github.com/OpenAnime/watch-together-socket.git

2. Go into the repo directory

   cd watch-together-socket

3. Install NPM packages

   npm i

4. Create an .env file using .env.example

5. Run locally

   npm run dev

   (back to top)

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

(back to top)

License

Distributed under the Business Source License 1.1. See license file for more information.

(back to top)

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's uWebSockets.js

(back to top)

Contributors

SpongeBed 💻 🖋 🤔 📆

Emirhan 🚇

(back to top)