Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/binaryb3ast/playsho-nest

This repository contains the backend codebase for the PlaySho Android app, built with NestJS , MongoDb , Socket.IO
https://github.com/binaryb3ast/playsho-nest

js mongodb nestjs socket-io typescript

Last synced: 2 months ago
JSON representation

This repository contains the backend codebase for the PlaySho Android app, built with NestJS , MongoDb , Socket.IO

Awesome Lists containing this project

README

        


PlaySho Logo

# PlaySho Backend (NestJS)
Welcome to the PlaySho backend repository! This NestJS application serves as the server-side component for the PlaySho Android app, allowing users to host and participate in synchronized movie-watching sessions with friends.

## 🛠️ Technologies Used:
- [**NestJS**](https://nestjs.com/): A progressive Node.js framework for building efficient, reliable, and scalable server-side applications.
- [**MongoDB**](https://www.mongodb.com/): A popular NoSQL database for storing application data.
- [**WebSocket**](https://socket.io/): Enables real-time communication between the server and clients, facilitating synchronized playback and chat functionality.
- [**JWT**](https://jwt.io/): JSON Web Tokens for secure authentication and authorization.

## 🚀 Getting Started:
1. Clone the Repository: git clone ```https://github.com/binaryb3ast/playsho-nest.git```
2. Install Dependencies: ```cd playsho-nest && npm install```
3. Set Up Environment Variables: Create a ```.env``` file based on the provided ```.env.example``` file and fill in the necessary values.
4. Start the Server: ```npm run start:dev``` for development mode or ```npm start``` for production mode.
5. Access the API: The API will be accessible at the specified port (default is ```localhost:3000```)

## 📱 Client App
For the client-side application of PlaySho, please visit the [PlaySho Android App repository](https://github.com/binaryb3ast/playsho).

## 🎉 Contribute:
Feel free to contribute to the development of PlaySho by submitting bug reports, feature requests, or pull requests. Let's make movie nights more enjoyable together!

## 📝 License:
This project is licensed under the MIT License - see the LICENSE file for details.