Flashii Chat web client
public | ||
src | ||
.editorconfig | ||
.env.example | ||
.gitattributes | ||
.gitignore | ||
build.js | ||
LICENCE | ||
Makefile | ||
package-lock.json | ||
package.json | ||
README.md |
Mami
The Flashii Chat client.
Branches
There are currently two "main" branches.
- The
master
branch contains the code for the chat client running onchat.flashii.net
, that's where patches for that should go. - The
trunk
branch contains a major overhaul of the codebase that will replace themaster
branch eventually.
Configuration
Configuration consists of a .env
file that contains the various URLs and a default chat title (the unified one is taken from whatever the remote common.json
supplies).
The defaults supplied by build.js
are what are used for the production instance. Make sure you modify them as needed!
Building
Mami uses a build script written in Node.js and a Makefile to make life easier.
I recommend using something like nvm
with a Node version of at least v22.14.0 (LTS)
.
The following make recipes are available:
# Runs the package install and build recipes
make [all]
# Installs package versions expected by package-lock.json
make install
# Runs the build process
make build
# Updates latest versions of packages expected by package.json
make update