Init repo

.gitbook.yaml

@@ -0,0 +1,9 @@
+root: ./docs/
+
+​structure:  
+  readme: README.md
+  summary: SUMMARY.md​
+
+redirects:  
+  help: README.md
+  description: SUMMARY.md​

.gitignore

@@ -0,0 +1,23 @@
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*

.whitesource

@@ -0,0 +1,12 @@
+{
+  "scanSettings": {
+    "baseBranches": []
+  },
+  "checkRunSettings": {
+    "vulnerableCheckRunConclusionLevel": "failure",
+    "displayMode": "diff"
+  },
+  "issueSettings": {
+    "minSeverityLevel": "LOW"
+  }
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Alexander
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,3 @@
+# Java Patterns
+
+Java design patterns

docs/README.md

@@ -0,0 +1,43 @@
+# Getting Started
+
+## _Installation_
+
+For full documentation visit [https://docs.gitbook.com/](https://docs.gitbook.com/).
+
+## _Description_
+
+With the help of _**GitBook**_ you can create and develop documentation on Kotlin Design patterns.
+
+## _Project Structure_
+
+```text
+mkdocs.yml    # Configuration file.
+docs/
+    index.md  # Documentation homepage
+    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 # Contribution page
+    links/
+        info.md # Contribution page
+```
+

docs/SUMMARY.md

@@ -0,0 +1,21 @@
+# Table of contents
+
+* [Getting Started](README.md)
+* [Contributing](contributing/README.md)
+  * [Contributing](contributing/info.md)
+* [User Guide](user-guide/README.md)
+  * [Upgrading](user-guide/upgrade.md)
+  * [Troubleshooting](user-guide/troubleshooting.md)
+  * [Getting Started](user-guide/getting-started.md)
+  * [FAQ](user-guide/faq.md)
+  * [Changelog](user-guide/changelog.md)
+  * [Code Owners](user-guide/code_owners.md)
+  * [Code of Conduct](user-guide/code_of_conduct.md)
+  * [Dependency Management](user-guide/dependency.md)
+* [Links](links/README.md)
+  * [Resources](links/info.md)
+* [Units](units/README.md)
+  * [Scenarios](units/scenarios.md)
+  * [Use Cases](units/use-cases.md)
+  * [Design Patterns](units/design-patterns.md)
+

docs/contributing/README.md

@@ -0,0 +1,2 @@
+# Contributing
+

docs/links/README.md

@@ -0,0 +1,2 @@
+# Links
+

docs/links/info.md

@@ -0,0 +1,84 @@
+# Resources
+
+## _Useful Links and Materials_
+
+* [**Scala Online Editor**](https://scalafiddle.io/)
+* [**Scala Style**](http://docs.scala-lang.org/style/)\*\*\*\*
+* \*\*\*\*[**Scala school**](http://twitter.github.io/scala_school/)\*\*\*\*
+* [**Scala official documentation**](https://docs.scala-lang.org/)\*\*\*\*
+* \*\*\*\*[**Learning Scala**](http://matt.might.net/articles/learning-scala-in-small-bites/)\*\*\*\*
+* \*\*\*\*[**Scala doc**](https://docs.scala-lang.org/)\*\*\*\*
+
+## _Popular Libraries and Utilities_
+
+{% tabs %}
+{% tab title="Web" %}
+* [Diode](https://diode.suzaku.io/)
+* [Laminar](https://github.com/raquo/Laminar)
+* [React Components](https://github.com/chandu0101/scalajs-react-components)
+* [Scala.js React](https://github.com/japgolly/scalajs-react)
+* [Scala CSS](https://japgolly.github.io/scalacss/book/)
+* [Slinky](https://slinky.dev/)
+* [Udash](https://udash.io/)
+* [Squabs](https://github.com/paypal/squbs)
+{% endtab %}
+
+{% tab title="Functional" %}
+* [Cats](https://typelevel.org/cats/)
+* [Cats Effect](https://github.com/typelevel/cats-effect)
+* [Cats MTL](https://github.com/typelevel/cats-mtl)
+* [Each](https://github.com/ThoughtWorksInc/each)
+* [FS2](https://github.com/typelevel/fs2)
+* [Hamsters](https://github.com/scala-hamsters/hamsters)
+* [Matryoshka](https://github.com/precog/matryoshka)
+* [Monix](https://monix.io/)
+* [Quicklens](https://github.com/softwaremill/quicklens)
+* [Refined](https://github.com/fthomas/refined)
+* [Scalaz](https://github.com/scalaz/scalaz)
+* [Shapeless](https://github.com/milessabin/shapeless)
+* [Simulacrum](https://github.com/typelevel/simulacrum)
+* [Spire](https://github.com/typelevel/spire)
+* [Squants](http://www.squants.com/)
+* [ZIO](https://zio.dev/)
+{% endtab %}
+
+{% tab title="FRP" %}
+* [Binding.scala](https://github.com/ThoughtWorksInc/Binding.scala)
+* [OutWatch](https://outwatch.github.io/?lang=scala)
+* [Owlet](https://oyanglul.us/owlet/)
+* [Reactify](https://github.com/outr/reactify)
+* [Scala.Rx](https://github.com/lihaoyi/scala.rx)
+* [bindable.scala](https://github.com/ThoughtWorksInc/bindable.scala)
+{% endtab %}
+
+{% tab title="Serialization" %}
+* [BooPickle](https://boopickle.suzaku.io/)
+* [Circe](https://circe.github.io/circe/)
+* [Play JSON](https://github.com/julienrf/play-json-derived-codecs)
+* [uPickle](https://github.com/lihaoyi/upickle)
+* [Json AST](https://json4s.org/)
+{% endtab %}
+
+{% tab title="Misc" %}
+* [Accord](http://wix.github.io/accord/) \(validation\)
+* [Akka.js](https://github.com/akka-js/akka.js)
+* [Collection](https://github.com/scala/collection-strawman)
+* [FastParse](http://www.lihaoyi.com/fastparse/)
+* [Java time](https://github.com/scala-js/scala-js-java-time)
+* [Quill](https://getquill.io/)
+* [RosHTTP](https://github.com/hmil/RosHTTP/blob/master/README.md)
+* [Scalafmt](https://scalameta.org/scalafmt/)
+* [Scalameta](https://scalameta.org/)
+* [sttp](https://sttp.softwaremill.com/en/latest/)
+* [Graph](http://www.scala-graph.org/)
+{% endtab %}
+
+{% tab title="Style" %}
+* [Scala style](http://www.scalastyle.org/maven.html)
+{% endtab %}
+
+{% tab title="Computing" %}
+* [Breeze](https://github.com/scalanlp/breeze)
+{% endtab %}
+{% endtabs %}
+

docs/units/README.md

@@ -0,0 +1,2 @@
+# Units
+

docs/units/design-patterns.md

@@ -0,0 +1,25 @@
+# Design Patterns
+
+## Getting Super Powers
+
+Becoming a super hero is a fairly straight forward process:
+
+```
+$ give me super-powers
+```
+
+{% hint style="info" %}
+ Super-powers are granted randomly so please submit an issue if you're not happy with yours.
+{% endhint %}
+
+Once you're strong enough, save the world:
+
+{% code title="hello.sh" %}
+```bash
+# Ain't no code for that yet, sorry
+echo 'You got to trust me on this, I saved the world'
+```
+{% endcode %}
+
+
+

docs/units/scenarios.md

@@ -0,0 +1,25 @@
+# Scenarios
+
+## Getting Super Powers
+
+Becoming a super hero is a fairly straight forward process:
+
+```
+$ give me super-powers
+```
+
+{% hint style="info" %}
+ Super-powers are granted randomly so please submit an issue if you're not happy with yours.
+{% endhint %}
+
+Once you're strong enough, save the world:
+
+{% code title="hello.sh" %}
+```bash
+# Ain't no code for that yet, sorry
+echo 'You got to trust me on this, I saved the world'
+```
+{% endcode %}
+
+
+

docs/units/use-cases.md

@@ -0,0 +1,25 @@
+# Use Cases
+
+## Getting Super Powers
+
+Becoming a super hero is a fairly straight forward process:
+
+```
+$ give me super-powers
+```
+
+{% hint style="info" %}
+ Super-powers are granted randomly so please submit an issue if you're not happy with yours.
+{% endhint %}
+
+Once you're strong enough, save the world:
+
+{% code title="hello.sh" %}
+```bash
+# Ain't no code for that yet, sorry
+echo 'You got to trust me on this, I saved the world'
+```
+{% endcode %}
+
+
+

docs/user-guide/README.md

@@ -0,0 +1,2 @@
+# User Guide
+

docs/user-guide/changelog.md

@@ -0,0 +1,18 @@
+# ![image info](../assets/icons/icons8-plan-64.png) Changelog
+
+## _15.0.0 - 2042-12-03_
+
+### _Fixed_
+
+* Removed humans, they weren't doing fine with animals.
+
+### _Changed_
+
+* Animals are now super cute, all of them.
+
+## _14.0.0 - 2042-10-06_
+
+### _Added_
+
+* Introduced animals into the world, we believe they're going to be a neat addition.
+

docs/user-guide/code_of_conduct.md

@@ -0,0 +1,55 @@
+# ![image info](../assets/icons/icons8-list-64.png) Code of Conduct
+
+All members, committers and volunteers in this project are required to act according to the following Code of Conduct. We ask you to follow these guidelines which help steer our interactions and strive to keep IceCore Hashids a positive and growing project and help us provide and ensure a safe environment for everyone.
+
+If you are being harassed, notice that someone else is being harassed, or have any other concerns, please contact us via [email](mailto:[email protected]). Your reports will be taken seriously and not dismissed or argued with.
+
+## _What we believe in and how we act_
+
+* In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. We welcome people regardless of these or other attributes.
+* Our community is based on mutual respect, tolerance, and encouragement.
+* We believe that a diverse community where people treat each other with respect is stronger, more vibrant and has more potential contributors and more sources for ideas. We aim for more diversity.
+* We are kind, welcoming and courteous to everyone.
+* We are respectful of others, their positions, their skills, their commitments and their efforts.
+* We are attentive in our communications, whether in person or online, and we are tactful and respectful when approaching differing views and experiences.
+* We are aware that language shapes reality. Thus, we use inclusive, gender-neutral language in the documents we provide and when we talk to people. When referring to a group of people, we aim to use gender-neutral terms like "team", "folks" or "everyone". [1](https://modelviewculture.com/pieces/gendered-language-feature-or-bug-in-software-documentation)
+* We respect that people have differences of opinion and criticize constructively.
+
+If you are being harassed, notice that someone else is being harassed, or have any other concerns, please contact us via [email](mailto:[email protected]). Your reports will be taken seriously and not dismissed or argued with.
+
+## _Unacceptable Behavior_
+
+* Do not be mean or rude.
+* Do not discriminate against anyone.
+* Sexism and racism of any kind \(including sexist and racist "jokes"\), demeaning or insulting behaviour and harassment are seen as direct violations to this Code of Conduct. Harassment includes offensive verbal comments related to age, body size, culture, ethnicity, gender expression, gender identity, level of experience, nationality, personal ability or disability, physical appearance, physical or mental difference, race, religion, set of skills, sexual orientation, socio-economic status, and subculture. Harassment also includes sexual images in public spaces, deliberate intimidation, stalking, following, harassing photography or recording, inappropriate physical contact, and unwelcome sexual attention.
+* Respect that some individuals and cultures consider the casual use of profanity offensive and off-putting.
+* Derailing, tone arguments and otherwise playing on people's desires to be nice are not welcome, especially in discussions about violations to this Code of Conduct.
+* Please avoid unstructured critique.
+* Likewise any spamming, trolling, flaming, baiting or other attention-stealing behaviour is not welcome.
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## _Responsibilities_
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+## _Enforcement_
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project core team members or owner via [email](mailto:[email protected]). The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## _Consequences for Violations_
+
+If a participant engages in any behaviour violating this Code of Conduct, the core team members and project owner of this project may take any action they deem appropriate, including warning the offender or expulsion from the project, exclusion from any interaction and loss of all rights in this project.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+Decisions about consequences of violations of this Code of Conduct are made by this projects core team members and project owner as named above and will not be discussed with the person responsible for the violation.
+
+## _Scope_
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+Thanks for the inspirations and attributions to GitHub's [Open Source Guides](https://opensource.guide), [Hoodie's Code of Conduct](http://hood.ie/code-of-conduct) and the [Contributor Covenant Version 1.4](http://contributor-covenant.org/version/1/4/).
+