Infinity-For-Lemmy/README.md

180 lines
5.9 KiB
Markdown
Raw Normal View History

<h1 align="center">
LemmInfinity (Infinity For Lemmy) <a href="https://www.patreon.com/docile_alligator"><img src="https://img.shields.io/badge/Patreon-F96854?style=for-the-badge&logo=patreon&logoColor=white" alt="Patreon"></a>
2022-09-16 16:05:51 +02:00
</h1>
2019-08-28 12:00:58 +02:00
<div align="center">
2022-07-15 04:55:47 +02:00
A Lemmy client on Android written in Java. It does not have any ads and it features a clean UI and smooth browsing experience
2022-07-15 04:55:47 +02:00
<img align="right" src="https://codeberg.org/Bazsalanszky/Infinity-For-Lemmy/raw/branch/master/fastlane/metadata/android/en-US/images/LemmInfinity.png" width=200>
2022-09-15 17:48:32 +02:00
</div>
2022-07-15 04:55:47 +02:00
<br>
2019-09-08 16:14:26 +02:00
2020-09-08 05:24:47 +02:00
<div align="center">
2022-07-15 04:55:47 +02:00
2022-09-15 18:02:41 +02:00
<br>
<a href="https://github.com/Docile-Alligator/Infinity-For-Reddit/wiki"><strong>Explore the docs »</strong></a>
<br>
<a href="https://codeberg.org/Bazsalanszky/Infinity-For-Lemmy/issues">Report a Bug</a>
·
<a href="https://codeberg.org/Bazsalanszky/Infinity-For-Lemmy/issues">Request a Feature</a>
·
<a href="https://codeberg.org/Bazsalanszky/Infinity-For-Lemmy/issues">Ask a Question</a>
2022-09-14 15:56:09 +02:00
</div>
2022-09-15 18:02:41 +02:00
<br>
<div align="center">
</div>
2023-06-27 01:51:52 +02:00
2022-09-16 16:04:15 +02:00
## Donation
2023-01-29 17:35:57 +01:00
<p>Infinity for Reddit+:</p>
2023-07-15 13:06:29 +02:00
<a href="https://play.google.com/store/apps/details?id=eu.toldi.infinityforlemmy.plus">
2023-01-29 17:35:57 +01:00
<img alt="Get it on Google Play" height="80" src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png" />
</a>
2022-09-16 16:04:15 +02:00
Patreon: https://www.patreon.com/docile_alligator
Bitcoin: bc1qxtkd5ap9na7uy8nr9qpt6jny6tdwaj4v43ddle
<details>
<summary>Table of Contents</summary>
- [About](#about)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Usage](#usage)
- [Cookiecutter template](#cookiecutter-template)
- [Manual setup](#manual-setup)
- [Variables reference](#variables-reference)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [Support](#support)
- [License](#license)
- [Acknowledgements](#acknowledgements)
</details>
2019-09-08 16:14:26 +02:00
---
2022-09-14 15:56:09 +02:00
## Action Items for LemmInfinity
- [x] Implementation of basic post browsing feature
- [x] Support for multiple account handling
- [x] Functionality for post upvotes/downvotes
- [ ] Functionality to browse comments
- [ ] Capability for creating a new post
- [ ] Ability to create comments
- [ ] Elimination of code/string references specific to Reddit
- [ ] Incorporation of private messaging feature
- [ ] Feature for saving posts
- [ ] Account editing function
- [ ] Multi community view?
## About The Project
<table>
<tr>
<td>
Key features of **Infinity For Reddit**:
- Lazy mode: Automatic scrolling of posts enables you to enjoy amazing posts without moving your thumb.
2019-08-28 12:00:58 +02:00
- Browsing posts
- View comments
- Expand and collapse comments section
- Vote posts and comments
- Save posts
- Write comments
- Edit comments and delete comments
- Submit posts (text, link, image and video)
- Edit posts (mark and unmark NSFW and spoiler and edit flair) and delete posts
- See all the subscribed subreddits and followed users
- View the messages
- Get notifications of unread messages
- etc...
2022-07-15 04:55:47 +02:00
</td>
</tr>
</table>
<img
src="https://raw.githubusercontent.com/Wladefant/Infinity-For-Reddit/master/fastlane/metadata/android/en-US/images/phoneScreenshots/1.png"
alt="Screenshot 1"
height="200" >
<img
src="https://raw.githubusercontent.com/Wladefant/Infinity-For-Reddit/master/fastlane/metadata/android/en-US/images/phoneScreenshots/2.png"
alt="Screenshot 2"
height="200" >
<img
src="https://raw.githubusercontent.com/Wladefant/Infinity-For-Reddit/master/fastlane/metadata/android/en-US/images/phoneScreenshots/3.png"
alt="Screenshot 3"
height="200" >
<img
src="https://raw.githubusercontent.com/Wladefant/Infinity-For-Reddit/master/fastlane/metadata/android/en-US/images/phoneScreenshots/4.png"
alt="Screenshot 4"
height="200" >
<img
src="https://raw.githubusercontent.com/Wladefant/Infinity-For-Reddit/master/fastlane/metadata/android/en-US/images/phoneScreenshots/5.png"
alt="Screenshot 5"
height="200" >
<img
src="https://raw.githubusercontent.com/Wladefant/Infinity-For-Reddit/master/fastlane/metadata/android/en-US/images/phoneScreenshots/6.png"
alt="Screenshot 6"
height="200" >
<img
src="https://raw.githubusercontent.com/Wladefant/Infinity-For-Reddit/master/fastlane/metadata/android/en-US/images/phoneScreenshots/7.png"
alt="Screenshot 7"
height="200" >
2022-07-15 04:55:47 +02:00
<p align="right">(<a href="#top">back to top</a>)</p>
## Contributing
First off, thanks for taking the time to contribute! Contributions are what makes the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request.
2022-10-23 04:31:55 +02:00
It's better to also open an issue describing the issue you want to fix. But it is not required.
2022-07-15 04:55:47 +02:00
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
Here are other ways you can help:
- [Report Bugs](https://github.com/Docile-Alligator/Infinity-For-Reddit/issues)
- [Make Suggestions](https://github.com/Docile-Alligator/Infinity-For-Reddit/discussions)
- [Translate The App](https://poeditor.com/join/project?hash=b2IRyfaJv6)
2022-07-15 04:55:47 +02:00
<p align="right">(<a href="#top">back to top</a>)</p>
## License
Distributed under the AGPL-3.0 License. See <a href="https://github.com/Docile-Alligator/Infinity-For-Reddit/blob/master/LICENSE">LICENSE</a> for more information.
2022-07-15 04:55:47 +02:00
<p align="right">(<a href="#top">back to top</a>)</p>
## Contact
2022-09-14 15:56:09 +02:00
[u/Hostilenemy](https://www.reddit.com/user/Hostilenemy) -
docilealligator.app@gmail.com (Owner)
or [u/Wladefant](https://www.reddit.com/user/Wladefant) - wladefant@gmail.com (Collaborator)
2022-07-15 04:55:47 +02:00
Project Link: [https://github.com/Docile-Alligator/Infinity-For-Reddit](https://github.com/Docile-Alligator/Infinity-For-Reddit)
2022-09-14 15:56:09 +02:00
<p align="right">(<a href="#top">back to top</a>)</p>