3 |
2 |
3 |
6 | An insight on all the data collected by Discord, formed into a video just like Spotify Wrapped! 7 |
8 | 9 | # Try it out 10 | You can try it out on [discordwrapped.com](https://discordwrapped.com). 11 | 12 | # Credits 13 | - [Face](https://github.com/face-hh) & [AssassiN](https://github.com/Assassin-1234) for starting the project 14 | - [Iliannnn](https://github.com/Iliannnn) for cleaning up the code and creating the website 15 | - [RedVortexDev](https://github.com/RedVortexDev) for redesign #1 16 | - [Arnav](https://github.com/arnav-kr) for redesign #2 17 | - [Zyztem](https://github.com/Zyztem) for dockerizing the project 18 | 19 | # Self-hosting 20 | 21 | ## Prerequisites: 22 | - Node.js and npm installed on your machine. 23 | 24 | ## Development 25 | 26 | ```bash 27 | git clone https://github.com/Assassin-1234/discord-wrapped.git 28 | cd discord-wrapped 29 | cd frontend 30 | npm install 31 | npm run dev 32 | cd .. 33 | cd backend 34 | npm install 35 | npm run dev 36 | ``` 37 | 38 | Open your web browser and go to [localhost:5173](http://) or the URL specified in the frontend logs if the default port is already in use. 39 | 40 | ## Production 41 | 42 | ### Docker 🐳 43 | ```bash 44 | git clone https://github.com/Assassin-1234/discord-wrapped.git 45 | cd discord-wrapped 46 | ``` 47 | 48 | Edit `.env.example` in the backend directory to your preference. 49 | 50 | ```bash 51 | docker-compose up -d 52 | ``` 53 | 54 | Using a reverse proxy, put the backend and frontend on the same address by adding a custom address `/api/` with the chosen backend port (3020 by default). 55 | 56 | ### Process Manager 57 | ```bash 58 | cd frontend 59 | npm install 60 | npm run build 61 | # Serve the build with your chosen process manager (e.g., http-server) 62 | cd .. 63 | cd backend 64 | mv .env.example .env 65 | npm install 66 | npm run build 67 | # Run with your chosen process manager 68 | xvfb-run -s "-ac -screen 0 1920x1080x24" npm run start 69 | ``` 70 | 71 | Using a reverse proxy, put the backend and frontend on the same address by adding a custom address `/api/` with the chosen backend port (3020 by default). 72 | 73 | # Contributing 74 | Pull requests are appreciated 75 | - Do not modify the `audio.mp3` 76 | - Do not push your own data package 77 | 78 | # License 79 | This OSS project is under an Apache license. 80 | 81 | # Contributors 82 | 83 |  84 | -------------------------------------------------------------------------------- /backend/.env.example: -------------------------------------------------------------------------------- 1 | APP_NAME="discord-wrapped-backend" 2 | APP_URL="discordwrapped.com" 3 | APP_ENV="production" 4 | APP_PORT=3020 -------------------------------------------------------------------------------- /backend/.eslintrc.cjs: -------------------------------------------------------------------------------- 1 | /* eslint-disable no-undef */ 2 | module.exports = { 3 | extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'], 4 | parser: '@typescript-eslint/parser', 5 | plugins: ['@typescript-eslint'], 6 | root: true, 7 | rules: { 8 | 'brace-style': ['error', '1tbs', { 'allowSingleLine': true }], 9 | 'comma-dangle': ['error', 'always-multiline'], 10 | 'comma-spacing': 'error', 11 | 'comma-style': 'error', 12 | 'curly': ['error', 'multi-line', 'consistent'], 13 | 'dot-location': ['error', 'property'], 14 | 'handle-callback-err': 'off', 15 | 'indent': ['error', 'tab'], 16 | 'max-nested-callbacks': ['error', { 'max': 4 }], 17 | 'max-statements-per-line': ['error', { 'max': 2 }], 18 | 'no-console': 'off', 19 | 'no-empty-function': 'off', 20 | '@typescript-eslint/no-empty-function': 'off', 21 | 'no-floating-decimal': 'error', 22 | 'no-inline-comments': 'error', 23 | 'no-lonely-if': 'error', 24 | 'no-multi-spaces': 'error', 25 | 'no-multiple-empty-lines': ['error', { 'max': 2, 'maxEOF': 1, 'maxBOF': 0 }], 26 | 'no-shadow': ['error', { 'allow': ['err', 'resolve', 'reject'] }], 27 | 'no-trailing-spaces': ['error'], 28 | 'no-var': 'error', 29 | 'object-curly-spacing': ['error', 'always'], 30 | 'prefer-const': 'error', 31 | 'quotes': ['error', 'single'], 32 | 'semi': ['error', 'always'], 33 | 'space-before-blocks': 'error', 34 | 'space-before-function-paren': ['error', { 35 | 'anonymous': 'never', 36 | 'named': 'never', 37 | 'asyncArrow': 'always', 38 | }], 39 | 'space-in-parens': 'error', 40 | 'space-infix-ops': 'error', 41 | 'space-unary-ops': 'error', 42 | 'spaced-comment': 'error', 43 | 'yoda': 'error', 44 | '@typescript-eslint/no-explicit-any': ['off'], 45 | }, 46 | }; -------------------------------------------------------------------------------- /backend/.gitignore: -------------------------------------------------------------------------------- 1 | # Build 2 | dist 3 | 4 | # Dependencies 5 | node_modules 6 | 7 | # Environment 8 | .env 9 | keys 10 | 11 | # Yarn & Npm 12 | yarn.lock 13 | yarn-error.log 14 | package-lock.json 15 | 16 | # Ffmpeg 17 | ffmpeg.exe 18 | ffprobe.exe -------------------------------------------------------------------------------- /backend/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node:lts 2 | 3 | WORKDIR /backend 4 | 5 | ENV DEBIAN_FRONTEND noninteractive 6 | 7 | RUN apt-get update && apt-get install -y \ 8 | dumb-init \ 9 | xvfb \ 10 | ffmpeg 11 | 12 | RUN rm /bin/sh && ln -s /bin/bash /bin/sh 13 | 14 | RUN apt-get update \ 15 | && apt-get install -y curl \ 16 | && apt-get -y autoclean 17 | 18 | ENV NODE_ENV "production" 19 | 20 | RUN apt-get update && apt-get -qqy install \ 21 | build-essential python3 python-is-python3 libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev libxi-dev libglu1-mesa-dev libglew-dev ffmpeg 22 | 23 | COPY package.json /backend/ 24 | COPY tsconfig.json /backend/ 25 | RUN npm install -g typescript@4.9.5 && npm install --location=project 26 | 27 | COPY . /backend/ 28 | RUN npm run build 29 | COPY .env.example .env 30 | RUN rm -rf /backend/Dockerfile /backend/.env.example 31 | 32 | EXPOSE 3020 33 | ENTRYPOINT ["/usr/bin/dumb-init", "--", "xvfb-run", "--server-args", "-screen 0 1280x1024x24 -ac"] 34 | CMD ["npm", "run", "start"] -------------------------------------------------------------------------------- /backend/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "discord-wrapped-backend", 3 | "version": "1.0.0", 4 | "description": "Discord Wrapped backend", 5 | "main": "src/app.ts", 6 | "author": "Iliannnn", 7 | "license": "Apache-2.0", 8 | "scripts": { 9 | "start": "node dist/app.js", 10 | "dev": "nodemon src/app.ts --watch src", 11 | "build": "tsc" 12 | }, 13 | "devDependencies": { 14 | "eslint": "^8.36.0", 15 | "nodemon": "^2.0.16", 16 | "ts-node": "^10.7.0", 17 | "typescript": "^4.9.5" 18 | }, 19 | "dependencies": { 20 | "@types/cors": "^2.8.12", 21 | "@types/express": "^4.17.13", 22 | "@types/fluent-ffmpeg": "^2.1.21", 23 | "@types/morgan": "^1.9.3", 24 | "@types/multer": "^1.4.7", 25 | "@types/node": "^17.0.31", 26 | "@types/sharp": "^0.31.1", 27 | "@types/ws": "^8.5.4", 28 | "@typescript-eslint/eslint-plugin": "^5.55.0", 29 | "@typescript-eslint/parser": "^5.55.0", 30 | "axios": "^1.3.4", 31 | "canvas": "^2.11.0", 32 | "cors": "^2.8.5", 33 | "dotenv": "^16.0.0", 34 | "editly": "^0.14.2", 35 | "express": "^4.18.1", 36 | "fluent-ffmpeg": "^2.1.2", 37 | "fs": "^0.0.1-security", 38 | "github-emoji": "^1.2.0", 39 | "helmet": "^5.1.0", 40 | "moment": "^2.29.3", 41 | "morgan": "^1.10.0", 42 | "multer": "^1.4.5-lts.1", 43 | "node-stream-zip": "^1.15.0", 44 | "path": "^0.12.7", 45 | "sharp": "^0.31.3", 46 | "snake-case": "^3.0.4", 47 | "ws": "^8.13.0" 48 | }, 49 | "optionalDependencies": { 50 | "bufferutil": "^4.0.7", 51 | "utf-8-validate": "^6.0.3" 52 | } 53 | } 54 | -------------------------------------------------------------------------------- /backend/src/api/Server.ts: -------------------------------------------------------------------------------- 1 | import Express, { Application } from 'express'; 2 | import { initRoutes } from './routes'; 3 | import { IConfig } from '../types/global'; 4 | 5 | /** 6 | * Server 7 | */ 8 | class Server { 9 | 10 | private _app: Application = Express(); 11 | public config: ServerOptions; 12 | 13 | constructor(options: ServerOptions) { 14 | this.config = options; 15 | initRoutes(this); 16 | } 17 | 18 | /** 19 | * Get Express application 20 | */ 21 | public get application(): Application { 22 | return this._app; 23 | } 24 | } 25 | 26 | export interface ServerOptions 27 | extends IConfig { 28 | prefix: string; 29 | } 30 | 31 | export default Server; -------------------------------------------------------------------------------- /backend/src/api/controllers/Controller.ts: -------------------------------------------------------------------------------- 1 | import Logger from '../../utils/Logger'; 2 | 3 | /** 4 | * Controller 5 | */ 6 | class Controller { 7 | 8 | /** 9 | * Node logger 10 | */ 11 | protected Logger: typeof Logger = Logger; 12 | } 13 | 14 | export default Controller; -------------------------------------------------------------------------------- /backend/src/api/controllers/GenerateController.ts: -------------------------------------------------------------------------------- 1 | import { Request, Response } from 'express'; 2 | import Controller from './Controller'; 3 | import wrap from '../../generator'; 4 | import { renameSync } from 'fs'; 5 | import WebSocket from 'ws'; 6 | import path from 'path'; 7 | 8 | /** 9 | * GenerateController 10 | * @extends Controller 11 | */ 12 | class GenerateController extends Controller { 13 | /** 14 | * Upload a data package 15 | * @param req Express request 16 | * @param res Express response 17 | * @returns {void} 18 | */ 19 | public async upload(req: Request, res: Response): PromiseAn insight on all the data collected by Discord, formed into a video just like Spotify Wrapped!
50 | 51 |We need your data package to be able to generate your wrapped. Find out 59 | how to request your data package in this article.
60 |Didn't receive your data package yet? Check out the demo on our demo page.
61 |We only use your data to generate your wrapped. We do not share your data with anyone. We do not sell your data. We do not use your data for anything else than generating your wrapped. Your data automatically gets deleted after your wrapped is generated.
66 |You can donate and thank us for our work on Ko-Fi with the button below.
71 | 74 |Discord Wrapped is open-source. You can find the source code in our GitHub repository. Feel free to contribute!
80 |If you like this project please consider staring the repository on GitHub, so we can reach more people.
81 |All wrappeds are stored in the storage of the server. This means that you got the time to download your wrapped before the server restarts. If you don't download your wrapped in time, you will have to generate it again.
86 |The website restarts everyday at {utcTime.toLocaleTimeString()}
87 |Discord Wrapped is not affiliated with Discord Inc. ● Made with ❤ by Iliannnn
93 |We are generating your wrapped. The bigger your data package is, the longer it usually takes.
259 |{info}
263 |We need your data package in order to generate your wrapped. Your data package will be removed immediately after your wrapped is done.
273 |Didn't receive your data package yet? Check out the demo on our demo page.
291 | 292 | )} 293 |