frontend.md

Frontend documentation

• 📂 front directory

Setup

install dependencies

npm ci

Build

build the frontend

npm run build

this will build in front/dist, you then need to start a server there

ex. with python

cd dist
python -m http.server

scratchy should then be on http://localhost:8000/index.html

Development server

to run the development server

npm run serve

Lint

if you plan on contributing, we'll ask you to lint your code, this should already happen on the development server, but to run only the linter :

npm run lint

Preview

vuejs components :

• activity-bar

  display the current room's name and allows room sharing

• login

  login popup

• message-list

  display all the messages of a room (or any array of messages really). this takes up most of the document's area.

• room-list

  display all joined room

• room-editor

  popup used to create / join rooms

• message-editor

  message input field

• user-list

  display the current room's users (broken right now because of never expiring caching)