bkobilansky / Charter

A Swift mailing list client for iPhone and iPad

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

An iOS client for the Swift mailing lists by @_matthewpalmer.



Details

Build Status

How do I run the iOS app?

You can download it from the App Store or run it yourself:

  1. git clone https://github.com/matthewpalmer/Charter
  2. cd iOS/Charter
  3. pod install
  4. open Charter.xcworkspace
  5. Run the app! Everything should be good to go.

How do I run the backend?

Running the backend is a little more tedious because it involves importing a bunch of archival data from the lists.swift.org website. Check out the README in the /Backend directory.

Can I contribute?

Of course! We’d love to see contributions from everyone, especially people trying to scratch an itch they’ve found after using the app. If you come across anything you want to work on, open an issue and get started.

If you’re keen to contribute but don’t feel like coding, there’s a bunch of stuff that needs to be done. We’re always trying to

  • improve the visual design of the app
  • improve the app icon
  • improve App Store marketing—think copy writing for the description, gorgeous screenshots, and maybe even a product video preview
  • translation and localisation (!!!)
  • improve the speed of the server or make the database more efficient
  • make suggestions, report bugs, ask questions, help people who ask questions

If you do any of the above, remember to open a PR to add yourself to the CONTRIBUTORS file!

About

A Swift mailing list client for iPhone and iPad

License:MIT License


Languages

Language:Swift 68.0%Language:JavaScript 22.2%Language:HTML 7.4%Language:Ruby 1.7%Language:Objective-C 0.4%Language:Shell 0.3%