#android #kotlin #beginners
3. #gitPanic - Documentation and Profiles
Documentation in Github goes far beyond a repo README.
Market Your Repos
Market Yourself
Best Practices
Wikis and Discussions
Market Your Repos
In Git 101 I mentioned that your GitHub profile could easily be a software development portfolio. Here's what I mean: every repo README is a chance to market your code to a potential employer. I've been asked plenty of times to explain code in my GitHub profile during an interview. Going through the process of creating a really good repo README can only help you prepare for those kinds of questions. I've even used READMEs to describe the work I did during bootcamp.
A README file contains information about the other files in software. On GitHub, the README is like the homepage of a repo. It uses GitHub-flavored markdown, so you can do a lot of formatting and add images, gifs, and videos. At a minimum, every project should have instructions on how to run the app.
Here are the sections I would add in addition to how to run the code:
About
Explain the problem you were trying to solve and how your app solves it. This will tell a hiring manager you can take a real world problem and solve it with code.
I've also used this section to describe updates, especially when I can link to a blog about them.
Usage
Deploy your app. Create an easy way for a potential employer to play around in your app, like a guest login. Link to it in this section. A hiring manager is almost never going to create an account, so make it really easy for them to see it works.
Explain the main functionality of the app. For example, a social media app would probably allow users to add and delete posts and see others' posts. To a hiring manager, this says you've coded the C, R, and D in CRUD.
Videos and Screenshots
For the hiring managers who won't even click the guest login, this section should be a walkthrough. I typically record my screen (cmd + shift + 5 on a mac) and use an online tool to convert it to a gif. One time in bootcamp, my friend recorded a video walkthrough and uploaded it to Youtube.
I try to always include desktop and mobile views, so hiring managers immediately know it's responsive.
Built With
Your tech stack with languages and links to packages. I typically include a line with the technologies I used to deploy the app too. The best apps look simple, but have a lot going on under the hood. This also allows a hiring manager to see if you used tools without combing through your code.
Acknowledgements
Always good to shout out anyone or any package that was integral to getting the app to work.
License
Licensing open source code is a big topic, and GitHub's license documentation is a good place to start. They even created www.choosealicense.com to help make it easier.
Without a license, the default copyright laws apply, which gives you minimal protection. With a license, you can tell other developers what they have to do to use your code.
Summary
If your README gets too long, it's straightforward to create a summary at the top that links to the sections with markdown. If you write a heading like ## Heading Text then the link would be [Heading Text](#heading-text).
Market Yourself
Since hiring managers are likely checking out your GitHub profile to get to your repos, it's another opportunity to show off your work. In GitHub, there are really three main parts to fill out - the bio, pinned repos, and the profile README. If you've done work in a repo you didn't create, you can still pin it on your profile.
Thanks to GitHub-flavored markdown, there's a lot you can do in your profile README. Mine has links to sites I've built, recordings of talks I've given, ways to connect, and a Blog Post Workflow written by @gautamkrishnar using Github Actions.
3. #gitPanic - Documentation and Profiles
Documentation in Github goes far beyond a repo README.
Market Your Repos
Market Yourself
Best Practices
Wikis and Discussions
Market Your Repos
In Git 101 I mentioned that your GitHub profile could easily be a software development portfolio. Here's what I mean: every repo README is a chance to market your code to a potential employer. I've been asked plenty of times to explain code in my GitHub profile during an interview. Going through the process of creating a really good repo README can only help you prepare for those kinds of questions. I've even used READMEs to describe the work I did during bootcamp.
A README file contains information about the other files in software. On GitHub, the README is like the homepage of a repo. It uses GitHub-flavored markdown, so you can do a lot of formatting and add images, gifs, and videos. At a minimum, every project should have instructions on how to run the app.
Here are the sections I would add in addition to how to run the code:
About
Explain the problem you were trying to solve and how your app solves it. This will tell a hiring manager you can take a real world problem and solve it with code.
I've also used this section to describe updates, especially when I can link to a blog about them.
Usage
Deploy your app. Create an easy way for a potential employer to play around in your app, like a guest login. Link to it in this section. A hiring manager is almost never going to create an account, so make it really easy for them to see it works.
Explain the main functionality of the app. For example, a social media app would probably allow users to add and delete posts and see others' posts. To a hiring manager, this says you've coded the C, R, and D in CRUD.
Videos and Screenshots
For the hiring managers who won't even click the guest login, this section should be a walkthrough. I typically record my screen (cmd + shift + 5 on a mac) and use an online tool to convert it to a gif. One time in bootcamp, my friend recorded a video walkthrough and uploaded it to Youtube.
I try to always include desktop and mobile views, so hiring managers immediately know it's responsive.
Built With
Your tech stack with languages and links to packages. I typically include a line with the technologies I used to deploy the app too. The best apps look simple, but have a lot going on under the hood. This also allows a hiring manager to see if you used tools without combing through your code.
Acknowledgements
Always good to shout out anyone or any package that was integral to getting the app to work.
License
Licensing open source code is a big topic, and GitHub's license documentation is a good place to start. They even created www.choosealicense.com to help make it easier.
Without a license, the default copyright laws apply, which gives you minimal protection. With a license, you can tell other developers what they have to do to use your code.
Summary
If your README gets too long, it's straightforward to create a summary at the top that links to the sections with markdown. If you write a heading like ## Heading Text then the link would be [Heading Text](#heading-text).
Market Yourself
Since hiring managers are likely checking out your GitHub profile to get to your repos, it's another opportunity to show off your work. In GitHub, there are really three main parts to fill out - the bio, pinned repos, and the profile README. If you've done work in a repo you didn't create, you can still pin it on your profile.
Thanks to GitHub-flavored markdown, there's a lot you can do in your profile README. Mine has links to sites I've built, recordings of talks I've given, ways to connect, and a Blog Post Workflow written by @gautamkrishnar using Github Actions.
dev.to
Samples of Using KMMBridge
What is KMM Bridge?
KMMBridge is a Gradle plugin by Touchlab that aims to simplify the process of pushing a Kotlin Multiplatform SDK binary to a remote repo to allow iOS developers to use the shared SDK without installing the Kotlin toolchain or building the Kotlin code on every app build.
What is this Sample?
This sample project showcases our typical project setup for adding Kotlin Multiplatform Mobile code to existing separate Android and iOS apps using KMMBridge. We keep the Android app a…
#kotlin #android #ios #mobile
Samples of Using KMMBridge
What is KMM Bridge?
KMMBridge is a Gradle plugin by Touchlab that aims to simplify the process of pushing a Kotlin Multiplatform SDK binary to a remote repo to allow iOS developers to use the shared SDK without installing the Kotlin toolchain or building the Kotlin code on every app build.
What is this Sample?
This sample project showcases our typical project setup for adding Kotlin Multiplatform Mobile code to existing separate Android and iOS apps using KMMBridge. We keep the Android app a…
#kotlin #android #ios #mobile
dev.to
1. Introduction to Android Studio, Project Structure, and Emulation.
I am very happy about Android obviously. I use Android, and it’s actually made cellphones very usable.”
~ Linus Torvald.
Hellooooo🥳️🥳️🥳️I am glad🤗 that you have joined me again in this Android development journey🚀. If you haven't read the The Fundamentals of Android Development article ensure you go through it to caught up with us. Do not forget to 👍like, comment👍 and share with your friends👨👨👦👦🥳️.
Article Objectives
In this article, we're going to look at:
Emulators and Android OS image…
#beginners #android #kotlin #motivation
2. AWS Text-To-Speech Serverless Application
In this article we will go through deploying a Text-To-Speech Serverless Application that contains two main flows presented in the following section.
Architecture
New Post
The user calls the API Gateway Restful endpoint that invokes the NewPost lambda function.
The NewPost Lambda function inserts information about the post into an Amazon DynamoDB table, where information about all posts is stored.
Then, the NewPost Lambda function publishes the post to the SNS topic we create, so it can be …
#aws #terraform #tutorial #javascript
1. Introduction to Android Studio, Project Structure, and Emulation.
I am very happy about Android obviously. I use Android, and it’s actually made cellphones very usable.”
~ Linus Torvald.
Hellooooo🥳️🥳️🥳️I am glad🤗 that you have joined me again in this Android development journey🚀. If you haven't read the The Fundamentals of Android Development article ensure you go through it to caught up with us. Do not forget to 👍like, comment👍 and share with your friends👨👨👦👦🥳️.
Article Objectives
In this article, we're going to look at:
Emulators and Android OS image…
#beginners #android #kotlin #motivation
2. AWS Text-To-Speech Serverless Application
In this article we will go through deploying a Text-To-Speech Serverless Application that contains two main flows presented in the following section.
Architecture
New Post
The user calls the API Gateway Restful endpoint that invokes the NewPost lambda function.
The NewPost Lambda function inserts information about the post into an Amazon DynamoDB table, where information about all posts is stored.
Then, the NewPost Lambda function publishes the post to the SNS topic we create, so it can be …
#aws #terraform #tutorial #javascript
dev.to
1. How to pass the arguments of Makefile.PL using cpanm
The command cpanm --installdeps . to install dependent modules executes perl Makefile.PL.
How to pass the arguments of perl Makefile.PL executed by cpanm.
The answer is using the --configure-args option.
cpanm --installdeps . --configure-args="--meta"
For Programming Beginners
cpanm is a command tool to install Perl modules from CPAN…
#perl #cpanm #beginners #programming
2. Android Compose DataStore Tutorial
Introduction
Hello! 👋
In this tutorial I will be introducing DataStore and how you can implement it into your Android Compose application. 😎
What is DataStore
DataStore is part Android Jetpack.
DataStore is a data storage solution that allows you to store key-value pairs or typed objects with protocol buffers. DataStore uses Kotlin coroutines and Flow to store data asynchronously, consistently and transactionally.
DataStore is ideal for small, simple datasets.
In simple terms it's the …
#android #kotlin #tutorial #beginners
3. 20 Git Commands you (probably) didn't know about
If you've ever browsed the git manual (or run man git), then you'll have noticed there's a whole lot more to git than what most of us use on a daily basis. A lot of these commands are incredibly powerful and can make your life a lot easier (others are a bit niche, but still good to know).
This post outlines 20 of my favourite under-used git features, which you can use to level up your development process, impress your colleagues, help you answer git interview questions, and most importantly - h…
#git
1. How to pass the arguments of Makefile.PL using cpanm
The command cpanm --installdeps . to install dependent modules executes perl Makefile.PL.
How to pass the arguments of perl Makefile.PL executed by cpanm.
The answer is using the --configure-args option.
cpanm --installdeps . --configure-args="--meta"
For Programming Beginners
cpanm is a command tool to install Perl modules from CPAN…
#perl #cpanm #beginners #programming
2. Android Compose DataStore Tutorial
Introduction
Hello! 👋
In this tutorial I will be introducing DataStore and how you can implement it into your Android Compose application. 😎
What is DataStore
DataStore is part Android Jetpack.
DataStore is a data storage solution that allows you to store key-value pairs or typed objects with protocol buffers. DataStore uses Kotlin coroutines and Flow to store data asynchronously, consistently and transactionally.
DataStore is ideal for small, simple datasets.
In simple terms it's the …
#android #kotlin #tutorial #beginners
3. 20 Git Commands you (probably) didn't know about
If you've ever browsed the git manual (or run man git), then you'll have noticed there's a whole lot more to git than what most of us use on a daily basis. A lot of these commands are incredibly powerful and can make your life a lot easier (others are a bit niche, but still good to know).
This post outlines 20 of my favourite under-used git features, which you can use to level up your development process, impress your colleagues, help you answer git interview questions, and most importantly - h…
#git
dev.to
1. How to solve coding issues using ChatGPT
The Issue I need to solve
Simply put, I need to check if a node package is installed in runtime. The reason is that I’m building a new toolkit ZenStack, for building secure CRUD apps with Next.js + Typescript. Since it is built above Prisma, when running the CLI provided by ZenStack, it must check whether Prisma has already been installed. Otherwise, it would prompt the user to install Prisma first.
Get the answer
Let’s try to ask ChatGPT directly:
Cool! The answer looks compelling. Proble…
#productivity #webdev #ai #programming
2. Android App Development Standards
Introduction and Problem
While developing android applications, developers are likely to encounter an unpleasant inconvenience, once their project starts growing, where their project becomes a big mess, where there is no clear naming standard, coding standard, or even project structure standard. Depending on what file a developer is editing, it can have a completely different standard, set of rules, and naming convention, than the other files. This is a direct result of the lack of android app …
#android #java #kotlin #tutorial
3. Angular registering animation triggers
This post keeps digging into AnimationRendererFactory creation routine, with a focus on triggers registering logic.
AnimationRenderer, the real one
Inside first article of this series we examined main concepts about Angular's AnimationRendererFactory and how it creates a "dumb" BaseAnimationRenderer to allow components not declaring any animation trigger to be known by the animation engine.
In this post we're going to analyze the creation process of a more interesting child class of the form…
#angular
1. How to solve coding issues using ChatGPT
The Issue I need to solve
Simply put, I need to check if a node package is installed in runtime. The reason is that I’m building a new toolkit ZenStack, for building secure CRUD apps with Next.js + Typescript. Since it is built above Prisma, when running the CLI provided by ZenStack, it must check whether Prisma has already been installed. Otherwise, it would prompt the user to install Prisma first.
Get the answer
Let’s try to ask ChatGPT directly:
Cool! The answer looks compelling. Proble…
#productivity #webdev #ai #programming
2. Android App Development Standards
Introduction and Problem
While developing android applications, developers are likely to encounter an unpleasant inconvenience, once their project starts growing, where their project becomes a big mess, where there is no clear naming standard, coding standard, or even project structure standard. Depending on what file a developer is editing, it can have a completely different standard, set of rules, and naming convention, than the other files. This is a direct result of the lack of android app …
#android #java #kotlin #tutorial
3. Angular registering animation triggers
This post keeps digging into AnimationRendererFactory creation routine, with a focus on triggers registering logic.
AnimationRenderer, the real one
Inside first article of this series we examined main concepts about Angular's AnimationRendererFactory and how it creates a "dumb" BaseAnimationRenderer to allow components not declaring any animation trigger to be known by the animation engine.
In this post we're going to analyze the creation process of a more interesting child class of the form…
#angular
dev.to
1. 9 websites that will help you learn web 🌐 development faster 🚀 and free 💯
Here is the list of the best 9 websites to help you learn web development.
How HTTP Works
Everything you need to know about HTTP based system.
30 Days of Node
Learn Node step by step with interactive examples and code snippet in 30 days.
How DNS Works
Learn what happens when you type a website address in your browser.
Git
Check out this excellent free website to learn git visually.
JavaScript
Visualize JavaScript code and learn the workflow.
Algorithm Visualizer
Algorithms are …
#webdev #tutorial #beginners #programming
2. Multiplatform Settings 1.0.0
Today, I've released version 1.0.0 of Multiplatform Settings. That means I'm committed to maintaining the current API surface of everything not marked as experimental until there's a 2.0 release (which I don't currently have plans for). If you need to save simple, unstructured key-value data in your multiplatform apps, I hope you'll consider using it. A lot of you already are!
russhwolf
/
multiplatform-settings
A Kotlin Multiplatform library for saving simple key-value data
Multiplatform…
#kotlin #kotlinmultiplatform
1. 9 websites that will help you learn web 🌐 development faster 🚀 and free 💯
Here is the list of the best 9 websites to help you learn web development.
How HTTP Works
Everything you need to know about HTTP based system.
30 Days of Node
Learn Node step by step with interactive examples and code snippet in 30 days.
How DNS Works
Learn what happens when you type a website address in your browser.
Git
Check out this excellent free website to learn git visually.
JavaScript
Visualize JavaScript code and learn the workflow.
Algorithm Visualizer
Algorithms are …
#webdev #tutorial #beginners #programming
2. Multiplatform Settings 1.0.0
Today, I've released version 1.0.0 of Multiplatform Settings. That means I'm committed to maintaining the current API surface of everything not marked as experimental until there's a 2.0 release (which I don't currently have plans for). If you need to save simple, unstructured key-value data in your multiplatform apps, I hope you'll consider using it. A lot of you already are!
russhwolf
/
multiplatform-settings
A Kotlin Multiplatform library for saving simple key-value data
Multiplatform…
#kotlin #kotlinmultiplatform
dev.to
1. Best VS Code extensions to use in 2023
Visual Studio Code, maintained by Microsoft, is one of the most popular open-source code editors out there. VS Code aims to offer all the tools you need while cutting out the complex workflows of full IDEs. Many programmers prefer VS Code because it offers so many extensions for added functionality, productivity, debugging, and speed.
In this quick guide, we’ll go over the best VS Code extensions that any web developer should use in 2023. We'll discuss what they do and how they can make your co…
#vscode #programming #tutorial
2. Most Common Five TypeScript Errors
TypeScript is a powerful open-source programming language that is a superset of JavaScript. It adds optional static typing, class-based object-oriented programming, and other features to JavaScript, making it a reliable language for large-scale software development. However, like any programming language, TypeScript is not without its errors. In this article, we will discuss some of the most common TypeScript errors and how to fix them to help developers write reliable code.
“Cannot find modul…
#typescript #commonerrors #javascript #troubleshooting
3. Creating an iCalendar event with HTML content
Introduction
The iCalendar format allows to define calendar events in a simple text file. The most common file extension of an iCalendar file is .ics and is supported by many apps, such as Outlook.
An iCalendar can define many types of information, such as events and to-dos, using many standard properties. Among these properties, an important one is missing for standard events, which is to define the event description in HTML. Indeed, the default description property DESCRIPTION takes only pla…
#kotlin #html #icalendar
1. Best VS Code extensions to use in 2023
Visual Studio Code, maintained by Microsoft, is one of the most popular open-source code editors out there. VS Code aims to offer all the tools you need while cutting out the complex workflows of full IDEs. Many programmers prefer VS Code because it offers so many extensions for added functionality, productivity, debugging, and speed.
In this quick guide, we’ll go over the best VS Code extensions that any web developer should use in 2023. We'll discuss what they do and how they can make your co…
#vscode #programming #tutorial
2. Most Common Five TypeScript Errors
TypeScript is a powerful open-source programming language that is a superset of JavaScript. It adds optional static typing, class-based object-oriented programming, and other features to JavaScript, making it a reliable language for large-scale software development. However, like any programming language, TypeScript is not without its errors. In this article, we will discuss some of the most common TypeScript errors and how to fix them to help developers write reliable code.
“Cannot find modul…
#typescript #commonerrors #javascript #troubleshooting
3. Creating an iCalendar event with HTML content
Introduction
The iCalendar format allows to define calendar events in a simple text file. The most common file extension of an iCalendar file is .ics and is supported by many apps, such as Outlook.
An iCalendar can define many types of information, such as events and to-dos, using many standard properties. Among these properties, an important one is missing for standard events, which is to define the event description in HTML. Indeed, the default description property DESCRIPTION takes only pla…
#kotlin #html #icalendar
dev.to
Null safety: Kotlin vs. Java
Last week, I was at the FOSDEM conference. FOSDEM is specific in that it has multiple rooms, each...
#kotlin #java #nullsafety
Null safety: Kotlin vs. Java
Last week, I was at the FOSDEM conference. FOSDEM is specific in that it has multiple rooms, each...
#kotlin #java #nullsafety
dev.to
Convert Android App to Use Material 3 Design
Step-by-step guide to convert a very simple Jetpack Compose Android app to use material 3...
#android #kotlin #beginners
Convert Android App to Use Material 3 Design
Step-by-step guide to convert a very simple Jetpack Compose Android app to use material 3...
#android #kotlin #beginners
dev.to
I Created A Simple Note App With Jetpack Compose
Introduction Hello! 😎 I created a simple note taking app using Jetpack Compose so I'd...
#android #programming #showdev #kotlin
I Created A Simple Note App With Jetpack Compose
Introduction Hello! 😎 I created a simple note taking app using Jetpack Compose so I'd...
#android #programming #showdev #kotlin
dev.to
Exposed RSQL Search Implementation
Overview In this tutorial, we are going to implement search functionality into the Exposed...
#kotlin #rsql
Exposed RSQL Search Implementation
Overview In this tutorial, we are going to implement search functionality into the Exposed...
#kotlin #rsql
dev.to
Kotlin Infix Notation is Confusing
If you see a method call that have space between, it is likely a Kotlin infix notation. Whenever I...
#kotlin #android #beginners
Kotlin Infix Notation is Confusing
If you see a method call that have space between, it is likely a Kotlin infix notation. Whenever I...
#kotlin #android #beginners
dev.to
Is There an Equivalent of Spring Boot for Kotlin?
If you look at my DEV profile, or meet me in person at a Meetup, I am sometimes the kind of guy that...
#kotlin #career #java #watercooler
Is There an Equivalent of Spring Boot for Kotlin?
If you look at my DEV profile, or meet me in person at a Meetup, I am sometimes the kind of guy that...
#kotlin #career #java #watercooler
dev.to
Let's create notification reminder app in Jetpack Compose.
Get yourself a cup of coffee before we dive into this interesting tutorial. @Composable fun...
#kotlin #android #tutorial
Let's create notification reminder app in Jetpack Compose.
Get yourself a cup of coffee before we dive into this interesting tutorial. @Composable fun...
#kotlin #android #tutorial
dev.to
Spring Boot + Electron, a case study
Background We recently finished writing our desktop app for Spring Actuator, Ostara....
#electron #springboot #kotlin #opensource
Spring Boot + Electron, a case study
Background We recently finished writing our desktop app for Spring Actuator, Ostara....
#electron #springboot #kotlin #opensource