2020-07-02 05:03:16 -04:00
|
|
|
# [gamja]
|
2020-04-25 06:40:15 -04:00
|
|
|
|
2021-06-11 04:19:46 -04:00
|
|
|
A simple IRC web client.
|
2020-04-25 06:40:15 -04:00
|
|
|
|
2020-07-24 03:51:02 -04:00
|
|
|
|
|
|
|
|
|
2020-06-24 08:55:49 -04:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
Requires an IRC WebSocket server.
|
|
|
|
|
|
2020-07-01 08:46:49 -04:00
|
|
|
First install dependencies:
|
|
|
|
|
|
|
|
|
|
npm install --production
|
|
|
|
|
|
2023-11-12 04:03:05 -05:00
|
|
|
Then [configure an HTTP server] to serve the gamja files.
|
2021-05-27 12:17:41 -04:00
|
|
|
|
2020-07-01 08:46:49 -04:00
|
|
|
### Development server
|
|
|
|
|
|
2021-12-01 04:34:41 -05:00
|
|
|
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:
|
2021-11-04 07:21:21 -04:00
|
|
|
|
|
|
|
|
npm install --include=dev
|
2021-12-01 04:34:41 -05:00
|
|
|
npm start -- irc.libera.chat
|
2020-07-01 08:46:49 -04:00
|
|
|
|
2021-12-01 04:44:03 -05:00
|
|
|
See `npm start -- -h` for a list of options.
|
|
|
|
|
|
2021-10-18 18:50:02 -04:00
|
|
|
### Production build
|
|
|
|
|
|
2021-11-04 07:21:21 -04:00
|
|
|
Optionally, [Parcel] can be used to build a minified version of gamja.
|
2021-10-18 18:50:02 -04:00
|
|
|
|
2021-11-04 07:21:21 -04:00
|
|
|
npm install --include=dev
|
|
|
|
|
npm run build
|
2021-10-18 18:50:02 -04:00
|
|
|
|
2023-11-12 04:03:05 -05:00
|
|
|
## Configuration
|
|
|
|
|
|
|
|
|
|
gamja can be configured via a [configuration file] and via [URL parameters].
|
2021-05-25 06:33:22 -04:00
|
|
|
|
2020-07-22 13:49:28 -04:00
|
|
|
## Contributing
|
|
|
|
|
|
2024-10-11 09:07:43 -04:00
|
|
|
Send patches on [Codeberg], report bugs on the [issue tracker]. Discuss
|
|
|
|
|
in [#soju on Libera Chat].
|
2020-07-22 13:49:28 -04:00
|
|
|
|
2020-04-25 06:40:15 -04:00
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
AGPLv3, see LICENSE.
|
|
|
|
|
|
2020-06-24 08:56:22 -04:00
|
|
|
Copyright (C) 2020 The gamja Contributors
|
2020-07-01 08:46:49 -04:00
|
|
|
|
2024-10-11 09:07:43 -04:00
|
|
|
[gamja]: https://codeberg.org/emersion/gamja
|
2024-09-03 15:08:13 -04:00
|
|
|
[Codeberg]: https://codeberg.org/emersion/gamja
|
2020-07-22 13:49:28 -04:00
|
|
|
[issue tracker]: https://todo.sr.ht/~emersion/gamja
|
2021-10-18 18:50:02 -04:00
|
|
|
[Parcel]: https://parceljs.org
|
2023-11-12 04:03:05 -05:00
|
|
|
[configure an HTTP server]: doc/setup.md
|
|
|
|
|
[configuration file]: doc/config-file.md
|
|
|
|
|
[URL parameters]: doc/url-params.md
|
2021-11-17 04:17:41 -05:00
|
|
|
[#soju on Libera Chat]: ircs://irc.libera.chat/#soju
|
