gamja-old/README.md
2024-10-11 15:06:44 +02:00

1.4 KiB

gamja

Warning

: this project has moved to Codeberg.

A simple IRC web client.

screenshot

Usage

Requires an IRC WebSocket server.

First install dependencies:

npm install --production

Then configure an HTTP server to serve the gamja files.

Development server

If you don't have an IRC WebSocket server at hand, gamja's development server can be used. For instance, to run gamja on Libera Chat:

npm install --include=dev
npm start -- irc.libera.chat

See npm start -- -h for a list of options.

Production build

Optionally, Parcel can be used to build a minified version of gamja.

npm install --include=dev
npm run build

Configuration

gamja can be configured via a configuration file and via URL parameters.

Contributing

Send patches on Codeberg or on the mailing list, report bugs on the issue tracker. Discuss in #soju on Libera Chat.

License

AGPLv3, see LICENSE.

Copyright (C) 2020 The gamja Contributors