These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Android Studio 3+ (latest version)
To qualify for the official limited edition Hacktoberfest shirt, you must register and then make four
pull requests (PRs) between October 1-31 (in any time zone). PRs can be made to any public repo on GitHub,
not only the ones with issues labeled Hacktoberfest.
This year, the first 50,000 participants who successfully complete the challenge will earn a T-shirt.
(Last year 46,088 earned a shirt!)
# register here: https://hacktoberfest.digitalocean.com
- First time using git? https://github.com/firstcontributions/first-contributions
- How To Create a Pull Request on GitHub: https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github
- Understand Github workflow:
# Create a fork then clone the fork on your machine
git clone https://github.com/yourRepo.git
# create a new branch to store any new changes. example of branch name: add-feature-xyz
git branch my-branch
# switch to that branch (line of development)
git checkout my-branch
# make changes, for example, edit `file1.md` and `file2.md` using the text editor
# stage the changed files
git add file1.md file2.md
# take a snapshot of the staging area (anything that's been added)
git commit -m "my snapshot"
# push changes to github
git push --set-upstream origin my-branch
# Create a new pull request using Github interface
Will add this latter
- AndroidX - Previously known as 'Android support Library'
- Glide - for loading and caching images
- Retrofit 2 - Type-safe HTTP client for Android and Java by Square, Inc.
- Gson - for serialization/deserialization Java Objects into JSON and back
- LiveData
- ViewModel
- Paging
- DataBinding
- OkHttp
- Timber
- CircleImageView
- TextDrawable
This project is released under the MIT license. See LICENSE for details.
MIT License
Copyright (c) 2019
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.