Scala Design Patterns

🎹 Table of contents

Scala Design Patterns

☝ Summary

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

📝 Documentation

The Website documentation is provided by gitbook and can be discovered at url:

Scala Patterns

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.

🧶 Kubernetes

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

⏰ Statistics

📝 Versioning

The project uses SemVer for versioning. For the versions available, see the tags on this repository.

🌹 Authors

Scala Patterns is maintained by the following GitHub team-members:

with community support please contact with us if you have some question or proposition.

💕 Contributing

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.

🚨 Visitor stats

⚽ Licensing

Scala Patterns is distributed under LGPL version 3 or later, [License]. LGPLv3 is additional permissions on top of GPLv3.

Name		Name	Last commit message	Last commit date
Latest commit History 1,882 Commits
.dependabot		.dependabot
.github		.github
.husky		.husky
charts		charts
config		config
docs		docs
images		images
k8s		k8s
okteto		okteto
policy		policy
reports		reports
scripts		scripts
tilt_modules		tilt_modules
traffic		traffic
.DEREK.yml		.DEREK.yml
.alexignore		.alexignore
.alexrc.js		.alexrc.js
.all-contributorsrc		.all-contributorsrc
.all-membersrc		.all-membersrc
.all-sponsorsrc		.all-sponsorsrc
.dockerignore		.dockerignore
.editorconfig		.editorconfig
.env.example		.env.example
.gitattributes		.gitattributes
.gitbook.yaml		.gitbook.yaml
.gitignore		.gitignore
.kodiak.toml		.kodiak.toml
.lintstagedrc.json		.lintstagedrc.json
.ls-lint.yml		.ls-lint.yml
.markdownlint.yml		.markdownlint.yml
.markdownlintignore		.markdownlintignore
.mergify.yml		.mergify.yml
.npmignore		.npmignore
.npmrc		.npmrc
.nvmrc		.nvmrc
.pre-commit-config.yaml		.pre-commit-config.yaml
.prettierignore		.prettierignore
.prettierrc.yaml		.prettierrc.yaml
.pylintrc		.pylintrc
.readthedocs.yaml		.readthedocs.yaml
.release-it.json		.release-it.json
.remarkrc		.remarkrc
.stignore		.stignore
.stylelintignore		.stylelintignore
.stylelintrc.json		.stylelintrc.json
.textlint.terms.json		.textlint.terms.json
.textlintrc.js		.textlintrc.js
.tiltignore		.tiltignore
.typo-ci.yml		.typo-ci.yml
.unibeautifyrc.json		.unibeautifyrc.json
.vimrc		.vimrc
.whitesource		.whitesource
.yaml-lint.yml		.yaml-lint.yml
.yarnrc		.yarnrc
AUTHORS		AUTHORS
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
CONTRIBUTORS		CONTRIBUTORS
Dockerfile		Dockerfile
LICENSE.txt		LICENSE.txt
Makefile		Makefile
OSSMETADATA		OSSMETADATA
README.md		README.md
SECURITY.md		SECURITY.md
Tiltfile		Tiltfile
appveyor.yml		appveyor.yml
changelog.config.js		changelog.config.js
codespell.txt		codespell.txt
cr.yaml		cr.yaml
ct.yaml		ct.yaml
default_rules.yaml		default_rules.yaml
docker-compose.yml		docker-compose.yml
gh-md-toc		gh-md-toc
lgtm.yml		lgtm.yml
mkdocs.yml		mkdocs.yml
okteto-pipeline.yml		okteto-pipeline.yml
okteto.yml		okteto.yml
package.json		package.json
pr-lint.config.js		pr-lint.config.js
record-start-time.py		record-start-time.py
record-start-time.sh		record-start-time.sh
renovate.json		renovate.json
version.txt		version.txt

License

AlexRogalskiy/scala-patterns

Folders and files

Latest commit

History