alxschmidt / mememuc

Meme generator (bonus project of LMU Munich course OMM WS22/23)

MemeMuc (Group 33)

ℹ️ About

Meme generator (bonus project of LMU Munich course OMM WS22/23)

👥 Team Members

Felix Bastian	Alexander Schmidt	You Sun Song	Ines Trautmannsheimer

🛫 Developing

1. Make sure Node.js version 18+ is installed (LTS recommended), includes npm.
2. Install recommended project extensions for your code editor (see .vscode/extensions.json).
3. Install project dependencies locally (for client & server): npm install
4. Start a local development server (for client & server): npm run dev

🏃 Running the MemeMuc Template

1. In order for the MemeMuc Template to be able to run mongorestore mongodb://127.0.0.1:65535 --db omm-ws2223 data as specified within ./mongoserver/package.json you need to have a local installation of MongoDB. The community edition suffices. It can be downloaded in the MongoDB download center.
2. Finally you will just need to run cd mememuc-launcher && npm run installall && npm start

📦 Used Packages (Client)

↪ View the Serverside README for backend packages.

Development

Package	License	Use
Vite	MIT	Frontend Tooling (Dev Server & Bundling)
Svelte	MIT	Frontend compile-time Framework
PostCSS (Autoprefixer)	MIT (MIT)	CSS post-processing (for auto browser prefixes)
ESLint (ESLint Plugin Svelte)	MIT (MIT)	Code Linting (for Svelte)

Bundled Code

Package	License	Use
Chart.js	MIT	Rendering of statistics graphs
html2canvas	MIT	Rendering Memes by capturing real DOM elements
pretty-bytes	MIT	Format bytes for better readability
svelte-spa-router	MIT	Routing for the frontend
Tippy.js	MIT	Tooltips (e. g. for Speech Input)