tokko55v2 / yarc

About

It's a CRUD application that has two main components a YARC_SDK which handles all the "backend" logic and the YARC itself which presents the data in a certain way.

The app itself and its ability to pull posts from Reddit is nothing special it's more a dummy for the infrastructure around it.

This repo should give me a apportunite to work with many infrastrucure tools like CI, Fastlane, XcodeGen ect.

Start the Project

Pull the project and direct to the folder app via Terminal. Use the command line xcodegen generate to create a YARC.xcodeproj.

The Infrastructure

I was curious how to setup up a project which has the ability to scale. It is basically a dummy for everything around the project.

• YARC_SDK
• Podfile for SwiftLint and R.swift
• Fastlane
• XcodeGen
• Github Actions

YARC_SDK

Fetches all the data between the Reddit API and the Application, including Error handling. YARC_SDK

Podfile

The Podfile is a specification that describes the dependencies of the targets of one or more Xcode projects. The file should simply be named Podfile PodFile

Swiftlint

A tool to enforce Swift style and conventions, loosely based on the now archived GitHub Swift Style Guide SwiftLint

R.swift

Get strong typed, autocompleted resources like images, fonts and segues in Swift projects R.swift

Fastlane

Fastlane is a tool for iOS and Android developers to automate tedious tasks like generating screenshots, dealing with provisioning profiles, and releasing your application. Fastlane

SwiftLint for CI

To run SwiftLint at Github Actions it was required to write a job for Github Actions. It is also necessary to declear in FastFile.swift a function called swiftLineLane.

jobs:
  RunLinter:
    runs-on: macos-latest
    steps:
      - uses: actions/checkout@v2
      
      - name: Install dependencies
        run: bundle install

      - name: Run linter
        run: bundle exec fastlane swiftLintLane

func swiftLintLane() {
    desc("Run SwiftLint")
    swiftlint(configFile: "app/.swiftlint.yml",
              strict: true,
              ignoreExitStatus: false,
              raiseIfSwiftlintError: true,
              executable: "Pods/SwiftLint/swiftlint")
}

XcodeGen

XcodeGen is a command line tool written in Swift that generates your Xcode project using your folder structure and a project spec. XcodeGen

Github Actions

For CI / CD including the following steps:

• On pull request to main branch
• Run SwiftLintLane

yarc's Issues

UserDefaults for entropy and initial profile

create initial profile - searchbar

by starting the app and clicking on Go! the yarc user has the opportunity to create his: her initial profile by choosing the most popular subreddits.

progress indicator for onboarding and main list view

yarc is using JGProgressHUD for the indicators
JGProgressHUD

onboarding favorite list

yarc user needs an onboarding process (yarc is the name of the application)

In this issue, the user has to select his subreddits and creates his:her initial profile
yarcs (users of the app) see after the initial profile an overview over all their previews selected subreddits

impl. error handling

profile has needs a database - CoreData

at the moment, the profile is saved in the cache.
This is suboptimal because after each new start the data is gone.

ReDesign Subreddit

impl. Subreddit Detail View

TODO: how should the SubReddi detail view look like.

subreddit main list

yarc user has the option to see all "joined" subreddits

• impl. as a list
• having the option to open the subreddit
• the list should have the following attributes
  • subscriber
  • icon image
  • title

Readme does not say what this repo is about

:P

UITests

unitTests

add LaunchScreen

right now - black screen.
add logo with primary color

README

fix navigationView

change color scheme

• RGB: 235 137 33 -> navigationColor, loginview
• RGB: 245 173 40 -> loginview
• RGB: 85 100 100 -> Background
• RGB: 0 0 0 -> Button Color
• RGB: 255 255 255 -> headerColor, tabColor