LSUG website

Overview

This is the source code for the London Scala User Group website which is a non-profit CIC (Community Interest Company). Both the HTTP server and website are written using the Scala Programming Language and are licensed under the copyleft license GPLv3.

Getting started

This project requires mill, npm and yarn to run. You'll also need git to clone the repository and ideally metals set up with Visual Studio Code, IntelliJ IDEA or an IDE of your choice.

Once setup with the prerequisites, you can run the HTTP server locally on localhost with:

mill -w web.run

This will start a background process, so that any changes you make will be reflected in the running server.

If you're only change the website and not the HTTP server, you can run the following to keep the HTTP server alive when the website updates:

mill web.run
mill -w web.bundle

The project has four modules,

• client which contains the website code
• server which is responsible for serving the website and HTTP resources
• protocol which contains the code shared between the two
• web which is used for deployment and contains certain static assets

Design

The LSUG website has been written in idiomatic functional scala. The number of dependencies has been deliberately kept low and certain design decisions to provide a good case study of how to use certain scala constructs and libraries. Performance is of a lesser concern.

Certain parts of the codebase are deliberately more or less advanced. Where possible, these are segregated into their own packages

Code of Conduct

The project is maintained by the organizers of LSUG and we are committed to providing a friendly, safe and welcoming environment to everyone. We ask that the community adheres to the Scala Code of Conduct.

Acknowledgements

Many thanks to the many library authors and maintainers which have made this project possible.