Scala Design Patterns is intended to provide various use case scenarios and architectural concepts on prototyping adaptive applications.
mkdocs.yml # Configuration file.
docs/
readme.md # General information
summary.md # Table of contents
units/
design-patterns.md # Design patterns and architectural concepts
scenarios.md # Scenarios in practice
use-cases.md # Typical use cases
user-guide/
changelog.md # Changelog page
code_of_conduct.md # Code of conduct page
code_owners.md # Code owners page
dependency.md # Dependency page
description.md # Description page
faq.md # FAQ page
getting-started.md # Getting started page
troubleshooting.md # Troubleshooting page
upgrade.md # Upgrade page
reporting/
info.md # Informational page
issue_template.md # Issue template page
bug_report.md # Bug report template
custom_report.md # Custom report template
feature_request_template.md # Feature request template
pull_request_template.md # Pull request template
contributing/
info.md # Contributing page
links/
info.md # Links page
The Website documentation is provided by gitbook and can be discovered at url:
To enable documentation serving at localhost you can run the following script
./scripts/build-docs.sh
otherwise, the next steps should be considered:
1) Install/upgrade pip command-line utility:
pip install --upgrade pip
or if you need to install pip for the first time:
wget --no-check-certificate https://bootstrap.pypa.io/get-pip.py
python get-pip.py
2) Install the mkdocs package using pip:
pip install mkdocs
or more conveniently for Windows subsystem:
python -m pip install mkdocs
python -m mkdocs
3) Install the material theme for the website:
python -m pip install mkdocs-material
python -m pip install markdown-include
...
(see requirements.txt)
...
4) Start the server at localhost by running the following command:
python -m mkdocs build --clean --config-file mkdocs.yml
python -m mkdocs serve --verbose --dirtyreload
5) Deploy to GitHub pages:
python -m mkdocs --verbose gh-deploy --force --remote-branch gh-pages
5) Open up localhost in browser to get the default documentation homepage.
Running k8s cluster with tilt command by acquiring k8s deployment configuration:
tilt up
Shutting down k8s cluster with provisioned resources removal:
tilt down --delete-namespaces
The project uses SemVer for versioning. For the versions available, see the tags on this repository.
Scala Patterns is maintained by the following GitHub team-members:
with community support please contact with us if you have some question or proposition.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us (emoji key).
This project follows the all-contributors specification. Contributions of any kind are welcome!
See also the list of contributors who participated in this project.
Scala Patterns is distributed under LGPL version 3 or later, [License]. LGPLv3 is additional permissions on top of GPLv3.
Like and Scala Patterns ? Consider buying me a coffee :)
- The IntelliJ Scala Plugin in 2024 | The IntelliJ Scala Plugin Blog
- Decisions4s: Complicated Conditionals, Higher Kinded Data and Scala 3
- How to test a websocket with zio-http 3.0.1
- Scala with Cats 2: Alternative implementation of Stream.filter
- ZIO 2.1.14 released π₯
- Mill Selective Execution
- Need equivalent windows command
- Accepting any IndexedSeq[IndexedSeq[_]]?
- Triemap
- sbt 2.0.0-M3 released
- 12 Top blog articles of 2015 β donβt miss these
- Type safe SalesForce Queries (SOQL) in Scala
- Scala vs. Node.js as a RESTful backend server
- Akka Management 1.1.0 Released
- Akka Projections 1.2.0 Released
- Akka 2.6.14 Released
- Akka HTTP 10.2.4 / 10.1.14 Released
- Akka 2.6.13 Released
- Akka gRPC 1.1.0 Released
- Akka 2.6.12 Released
- Akka Projections 1.1.0 Released
- Akka Persistence JDBC 5.0.0 Released
- Akka HTTP 10.2.3 Released
- Introducing the com-lihaoyi Github Organization
- From First Principles: Why Scala?
- Message-based Parallelism with Actors
- The Death of Hype: What's Next for Scala
- Standardizing IO Interfaces for Scala Libraries
- Beyond Liskov: Type Safe Equality in Scala
- How an Optimizing Compiler Works
- Working with Databases using Scala and Quill
- Scraping Websites using Scala and Jsoup
- Simple Web and Api Servers with Scala
- The Scala Center Action Towards a More Safe and Respectful Community Environment
- Scala 3 in sbt 1.5
- Preventing Version Conflicts with versionScheme
- Scala Native 0.4.0 is here!
- Scala 3 - Crossing the finish line
- Forward Compatibility for the Scala 3 Transition
- BSP Support in sbt 1.4
- Scala 3 - A community powered release
- The Scala Center stands with Black Lives Matter
- Import Suggestions in Scala 3
- Blockchain β The Next Generation Of The Internet
- Real estate tokenization: a practical guide
- Understand The Basics Of Tokenization
- How do we build a PRO tech team?
- Building Ecommerce Shop | Migrating From Woocommerce To Shopify
- How Outsourcing Can Solve Technical Debt
- Top 15 Scala Libraries for Data Science in 2021
- How To Tackle Technical Debt Quadrants?
- 13 Elements That Contribute To Technical Debt
- Financial Intelligence At Airbnb With Scala β A Case Study