Code Monkey home page Code Monkey logo

area51's Introduction

Area51 App Icon

Area51

Build Status

Area51 is an open source Reddit client for iOS built entirely in Swift!

Get the public beta on TestFlight

Join the public Slack channel to collaborate!

Goals

  • Provide a beginner friendly development environment
  • Use the latest iOS development tools
  • Document everything! Helps beginners learn :)
  • Build an awesome open source Reddit client for iOS!

Getting Started

Requirements

Make sure you have Xcode: 10.1 or higher.

This project currently supports Swift 4.2+

Setup

Clone the repo and run the generate command:

git clone [email protected]:kgellci/Area51.git
cd Area51/
make generate

After generate is finished doing its job, open Area51.xcodeproj, build and run.

Project Structure

Area51 does not import any 3rd party libraries in app.

Xcodegen is used for project definition and generation.

Swiftlint is used to keep the code properly structured and readable.

Learn more about the project structure.

Running on a device

Make sure you run make generate command from above to generate the appropriate config files.

Edit the user.xcconfig file in the Configs/ directory (don't worry, it is gitignored!). Set DEVELOPMENT_TEAM in the user.xcconfig file. Example: DEVELOPMENT_TEAM = XXXXXXXXX

Edit the bundleIdentifier.xcconfig file in Configs/ directory (also gitignored!). Set PRODUCT_BUNDLE_IDENTIFIER in bundleIdentifier.xcconfig to something unique, Example: PRODUCT_BUNDLE_IDENTIFIER = whatever.i.want

You will need to close the Xcode project, run make generate and open the project again. You can find your team ID by logging into developer.apple.com.

FAQ

If you have more questions, check out the FAQ. If your question is not answered, open a new issue with the "Question" tag.

License

Area51 is licensed under the GNU General Public License v3.0. See LICENSE for more info.

area51's People

Contributors

andergoig avatar dulithadabare avatar emichaux avatar errornow avatar felixfoertsch avatar jackattack24 avatar kgellci avatar lucashoeft avatar mahmoudfotta avatar nickset avatar rj-clegg avatar sinbu avatar slo-addy avatar squarefrog avatar

Watchers

 avatar  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.