jekyllex / jekyllex-android

JekyllEx is an Android app that can manage your Jekyll blog directly from your Android device!

JekyllEx Android App

_{Built with ❤︎ by Gourav Khunger}

🚀 Introduction

JekyllEx is an Android App that allows you to manage a Jekyll Blog directly from your Android device!

Read the blog post for better understanding 😃.

✨ Try it out

Download and install the latest release of the app to start relishing the power of blogging from your mobile.

🔗 Handy Links

• GitHub: https://github.com/jekyllex
• Website: https://jekyllex.xyz
• Documentation: https://docs.jekyllex.xyz
• Api: https://api.jekyllex.xyz
• Demo blog used for testing jekyllex: https://demo.jekyllex.xyz

🛠️ Technical details

The development of JekyllEx Androi App is done on the dev branch.

The codebase of this app is based on the MVVM pattern. Here's a list of tools/libraries/components JekyllEx uses:

Platform

• Android

Languages Used

• Kotlin
• XML

Libraries

• Android Architecture Components
• Auth0 : For user authentication
• Retrofit : For network requests
• Room : For local database and caching user profile
• Kotlin extensions and Coroutines for Room
• Markwon : Markdown rendering
• App Updater : To check for updates from GitHub Releases
• Glide : For image loading.
• Firebase : For push notifications, analytics and crashlytics.

⚙ Local Setup

To build this app on your local machine:

1. Clone the repository

   git clone https://github.com/jekyllex/jekyllex-android.git
   

2. Make gradle.properties file in the cloned folder with the following content:

   android.useAndroidX=true
   android.enableJetifier=true
   
   Auth0ClientId="enter Auth0 client ID here"
   API_AUDIENCE="enter custom API audience link here"

   Other properties can vary from machine to machine, the required parameters are Auth0ClientId AND API_AUDIENCE

3. Make a firebase project and add connect the project with it.

4. You're done with setting up local development!

👨‍💻 Author

Gourav Khunger - Learn more about me.

😄 Support

Please give this project a ⭐ to motivate me for improving JekyllEx!

Consider donating some coffee if you wish to support me to make more open source projects ;)

🛡 License

This project is MIT Licensed.

MIT License

Copyright (c) 2021 Gourav Khunger

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.

---

JekyllEx needs a ⭐ from you =)

jekyllex-android's Issues

Use Paging 3 Library for Pagination

Could we use Paging 3 Library to handle pagination on the App home page effectively?

F-Droid and Google Play app hosting

Hey @gouravkhunger

Congratulations on creating this neat app!

Have you considered hosting this app on F-Droid and/or Google Play? This would allow users to receive updates without having to check the github repo.

While I don't have to explain Google Play to you, F-Droid is a repo and package management system for FOSS apps such as yours. So long as your app abides by their inclusion policy (do check out their FAQ), you should be able to push your app to their repo and have anyone download it using the F-Droid app store for free.

Somone even wrote a post on how they did it.

Good luck young padawan!

Test

Edit: accidental post

Access blog from another organization?

This app looks like exactly what I need, but my blog is actually on a different organization that I've made, in order to make the GitHub pages URL of my blog shorter. I granted your app access to that organization when I was logging in, but it doesn't appear to have searched it. If you could make it possible to do that that would be amazing, thank you so much!

Site

Font and theme options

I haven't really had a chance to use this app extensively yet, due to what I talked about in my other issue, but since you were asking one of the features that would really help me is the ability to make the app easier on the eyes:

1. A large serif font such as Libre Baskerville for the text entry and blog rendering interfaces would make it much easier to read for me.
2. A low contrast/easy on the eyes theme (black on light yellow or something) that eliminates blue would be really stellar.

Both of these features would be really useful for me because I have chronic migraines that are in part triggered very easily by eye strain.

Speaking of which, once I feel better from this cycle of migraines I might try contributing :)