Giter Club home page Giter Club logo

memmy's Introduction

memmy - An iOS client for Lemmy

TestFlight Builds

You can now download and run Memmy on your iOS device by using TestFlight. To join the beta group and start doom scrolling, click here and join the group. Please submit feedback either by

  • Screenshotting the issue you are having, then press the image. When you go to save it, you'll have an option to submit feedback. I'll receive the screenshot and your message.
  • Opening an issue here on GitHub. There are also discussions where we can talk about idea or features you are thinking about.
  • Message me on Lemmy or on the Memmy community
  • Chat on Discord

About

An Apollo-inspired iOS client for using Lemmy, a federated link aggregator. Heavly influenced and inspired by Apollo for Reddit. Thanks Christian.

Work in Progress

This is a work in progress and is not in a functional state - yet. I intend to release builds at least nightly on TestFlight, although I am going a bit fast right now (getting ready for the withdraw from no longer having Apollo!)

Requirements

Building

Building for iOS requires a Mac. To build, you will also need to make sure that you have the required dependencies installed. Generally, this is Ruby and Xcode. You'll also need yarn.

git clone https://github.com/memmy-app/memmy
cd memmy
yarn install

# EITHER
cd ios
pod install

#OR
npx pod install

yarn ios

A simulator should open with the app running. To change the device type or to deply to your physical device, run yarn ios --device and select the device you want to deploy to.

Info

This application uses Expo. The various pluses to using Expo/React Native are the following:

More opportunities for others to contribute

While there are certainly plenty of people who are adept at Swift, there are already a few projects out there that are using Swift to create their iOS Lemmy applications. I'd like to have a codebase where those who may not have a good grasp of native mobile app development to have a chance to contribute, such as those who already have a good grasp of React.

Compatible with already existing libraries

Especially since Lemmy is an ongoing project that will certainly evolve over time, we can easily use the official lemmy-js-client library to make our API calls. If changes to the API are made, we can expect this library to be updated by Lemmy developers themselves. This also saves on production time for us.

Contribution

Some rules and guidelines:

  • Don't make PRs that add entirely new features without discussing with us first (either ask in Discord or open an issue)
  • We may not respond to your issue or PR (but that doesn't mean we don't look at it, we're really busy now!)
  • We may close a PR without much feedback
  • We can't guarantee that we can provide support for build issues
  • Check for exisitng issues before filing a new one
  • Open an issue and give us time to review it before opening a PR

Themes

To contribute to themes, you can create a new theme object in theme/theme.ts. Once you create it with all the proper colors and extend it with extendTheme(), you must then add it to EThemeOptions and ThemeOptionsMap in theme/themeOptions.ts. This will automatically add it to the theme selector in the settings page.

Acknowledgements

Thanks to [email protected] for creating app graphics.

Buy Me A Coffee

memmy's People

Contributors

beardwin avatar bohn002 avatar br337 avatar chakigel avatar dependabot[bot] avatar dsl101 avatar eoddc5 avatar flx-sta avatar game-warrior avatar gitbrent avatar gkasdorf avatar inquisicionespanola avatar jacksonopp avatar jderose9 avatar joshua-davis-rose avatar justincmoy avatar ktgd avatar mxmvncnt avatar ntoporcov avatar pbocek avatar phriedrich avatar qoopa avatar rosvik avatar sgriff96 avatar tysoncodes avatar yrahul3910 avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.