https://github.com/math-pixel/photo-party
Photo-Party is an interactive game where people can share images, videos and texts in real time on a large screen using a video projector, for example.
https://github.com/math-pixel/photo-party
Last synced: 3 months ago
JSON representation
Photo-Party is an interactive game where people can share images, videos and texts in real time on a large screen using a video projector, for example.
- Host: GitHub
- URL: https://github.com/math-pixel/photo-party
- Owner: math-pixel
- Created: 2023-10-18T06:11:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-21T14:22:54.000Z (about 1 year ago)
- Last Synced: 2025-05-14T06:51:16.505Z (about 1 year ago)
- Language: HTML
- Homepage:
- Size: 5.59 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Photo Party
Photo Party is an application for shared photos of your party on a big screen in real time.
## Tech
## Installation
Install Photo Party with npm
1)
```bash
git clone the repo
```
2)
```bash
cd ./Photo-Party
```
3)
```bash
duplicate and rename the ".env-example" > ".env"
```
4)
```bash
npm install
```
5)
```bash
unzip, import and deploy database of "template database.zip" in localhost
```
6)
```bash
npm run server
```
7) In Webbrowser go to
```bash
player => localhost:5000/
admin => localhost:5000/admin
projector => localhost:5000/projecteur
```
## Shema
### Architecture

### Sequence Diagram

### Mermaid Diagram theme :
```json
{
"theme": "base",
"themeVariables": {
"primaryColor": "#3C41FF",
"actorTextColor": "#ffff",
"primaryTextColor": "#000470",
"secondaryTextColor": "#FF0000",
"primaryBorderColor": "#000",
"lineColor": "#000",
"secondaryColor": "#ffffff",
"tertiaryColor": "#000"
}
}
```
## EndPoint
### Client :
#### Connection :
```bash
GET /
```
#### Send data :
```bash
POST /importingFile
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `image` | `blob` | Image UPLOAD |
| `comment` | `text` | text UPLOAD |
| `email` | `text` | email of user |
| `nom` | `text` | username of user |
### Projector :
_Establish a WebSocket connection_
#### Connection :
```bash
GET /projecteur
```
### Admin :
_Establish a WebSocket connection_
#### Connection :
```bash
GET /admin
```
#### Admin Pannel :
```bash
POST /administration
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `nom` | `text` | Admin Username |
| `mdp` | `text` | Admin Password |
#### Admin Pannel Parameter :
```bash
POST /adminParameter
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `image1isChange` | `bool` | Testing Variable |
| `image2isChange` | `bool` | Testing Variable |
| `comeToParameter` | `bool` | Testing Variable |
| `nom` | `text` | Admin Username |
| `mdp` | `text` | Admin Password |
## Color Reference
| Color | Hex |
| ----------------- | ------------------------------------------------------------------ |
| Primary Color |  #3C41FF |
| Black |  #000 |
| White |  #fff |
## Logo

## Features
- Remove french words