This is the repository for all the unit tested examples you will find in RealKotlin.com
I would ❤️ some contributions from other authors here. Just follow these steps
- Fork this repository
- Create a new test in
src/test/kotlin/Examples
using the "Real Kotlin Spek" file template.File > New > Real Kotlin Spek
. Tests are written using Spek Framework.
- Create a new "Real Kotlin File" in
src/main/kotlin/Examples
using the provided template.File > New > Real Kotlin File
- Send me a pull request with everything
- 🤗 wait for my virtual hug and for your code to be sent to all RealKotlin.com subscribers.
- Bask in the glory of being an Open Source contributor
Posts are automatically generated after each example, which gets converted into markdown using the metadata added in JavaDocs style at the top of each file.
To generate posts and run them locally and make sure everything looks good, clone this repository and check its README file to see how to run the website.
- In the file-root of the website copy the path to
_tutorials
- Back in this Kotlin project 👆 rename
sample-local.properties
tolocal.properties
. - In that file add the path to
_tutorials
you've copied intoblogExportPath
- for the
examplePath
, copy the absolute path tosrc/main/kotlin/examples
. - Now run
gradle runGenerator
or openParser/JavadocParser.kt
and run itsmain
function. - The new markdown file will get created in the website's folder.
- Ah... that warm feeling of automation 💃
- I'll take care of the publish date and adding you as the author.