A collection of Swift Tutorials built with Apple's DocC.

Overview

Swift Tutorials

This is not a package, it's just a bunch of tutorials

deploy website

This project uses Apple's DocC (Documentation Compiler) to create a set of SwiftUI tutorials for students.

Requirements

  • Xcode 13.0 (Beta 5)

Creating DocC

  1. Open the Package.swift file
  2. In the menu bar, Product → Build Documentation
    • Alternatively, if you have the dexterity for it, use +++D (Command+Control+Shift+D)
  3. The tutorials should open up in the Documentation viewer

DocC on Web

Thanks Ryan The for helping with the web set up.

Building

  1. Run npm i in the Web folder
  2. To run it locally, run npm run dev
  3. Open http://localhost:3000/ with your browser to see the results.

Updating DocC

Don't bother editing the /Web/Sources folder as it is auto-generated by running build.sh.

There is a GitHub Action to deploy onto Vercel. If it is on main, it should be on production.

Run build.sh to update the DocC web

$ sh build.sh

Errors (and possible solutions)

  • xcodebuild: error: Unknown build action 'docbuild'.
    • Run xcode-select --switch /Path/To/Xcode.app.
    • Ensure the path leads to Xcode 13.

Contributing

For more information on contributing to these tutorials, visit learn.swiftinsg.org/contributing.

Issues

Spot an issue in the tutorial? Use the issues template to submit an issue

Comments
  • [Action] Everything goes to production

    [Action] Everything goes to production

    I think I messed up the Vercel action, it pushes everything to production before getting merged into main.

    I should get around to fixing it, maybe later, maybe never.

    opened by jiachenyee 0
  • This should be friends

    This should be friends

    Before:

    Text(friend[index].school)

    After:

    Text(friends[index].school)

    https://github.com/tinkercademy/Swift-Tutorials/blob/2eb33175df3c98824110b9b833f4847bb04f587f/Sources/swiftinsg/Documentation.docc/Resources/Friends%20App/Chapter%202/Binding/Section%201/friends-ch2-binding-s1-4-ContentView.swift#L28

    content typos 
    opened by yjsoon 0
  • [CONTENT] fetchData() method not called in ContentView.swift for Firey Flag Raising tutorial

    [CONTENT] fetchData() method not called in ContentView.swift for Firey Flag Raising tutorial

    Describe the issue

    The fetchData() method is never called, resulting in the application never observing for changes in the real-time database.

    Where's the Issue? Tutorial: Firey Flag Raising Chapter: 1 Tutorial: Reading & Writing Data Section: 5 Step: 6

    Screenshots If applicable, add screenshots to help explain your problem.

    Expected result There should be a section 6 which instructs the audience to call the onAppear method on TabView .

    TabView {
       ...
    }
    .onAppear() {
                flagDataManager.setupDataObserver()
    }
    

    Additional context Add any other context about the problem here.

    opened by jamesrchen 1
  • [FEATURE] Show tags based on concepts taught in each lesson

    [FEATURE] Show tags based on concepts taught in each lesson

    Maybe we should add tags based on what is taught within each lesson on the home page Safari - swiftinsg | Documentation  2021-07-19 at 04 53 40AM

    Something like what we do on Notion image

    it shouldn't be too hard... wait... i'll probably be the one to implement it... oh man

    enhancement 
    opened by jiachenyee 0
  • [CONTENT] Consistent List Style

    [CONTENT] Consistent List Style

    Describe the issue

    Ex: Misspelled potato as tomato. This makes the code unable to compile. A clear and concise description of what the problem is.

    Where's the Issue? Tutorial: friends Chapter: 2, 3

    Screenshots If applicable, add screenshots to help explain your problem.

    Expected result Consistent List style between chapters 2 and 3

    Additional context Add any other context about the problem here.

    content enhancement 
    opened by jiachenyee 0
Owner
Swift Innovators Network
Home of the Swift Accelerator Programme Singapore
Swift Innovators Network
Tutorials from sparrowcode.io website. You can add new, translate or fix typos. Also you can add your apps from App Store for free.

Страницы доступны на sparrowcode.io/en & sparrowcode.io/ru Как добавить свое приложение Добавьте элемент в json /ru/apps/apps.json. Если ваше приложен

Sparrow Code 31 Nov 8, 2022
A Collection of PropertyWrappers to make custom Serialization of Swift Codable Types easy

CodableWrappers Simplified Serialization with Property Wrappers Move your Codable and (En/De)coder customization to annotations! struct YourType: Coda

null 379 Nov 17, 2022
A patch collection to save your Xcode

Patch Xcode is worst IDE I have ever used Xcode 13.3 introduced a very annoying bug. When you type anything with Chinese IME in the LLDB console

Cyandev 100 Nov 14, 2022
A collection of native SwiftUI layouts (iOS 16+)

SwiftUILayouts A library of commonly requested layouts. Implemented using SwiftUI's native layout system. NOTE: SwiftUILayouts requires iOS 16 or abov

Apptek Studios 20 Nov 16, 2022
A fancy collection style view controller that was inspired by this Profile Card mockup

JFCardSelectionViewController A fancy collection style view controller that was inspired by this Profile Card mockup: https://dribbble.com/shots/14584

Jeremy Fox 431 Oct 11, 2022
A collection of common SwiftUI and UIKit utilities.

KippleUI A collection of common SwiftUI and UIKit utilities. ⚠️ The code in this library has been made public as-is for the purposes of education, dis

Kipple 10 Sep 2, 2022
A collection of common diagnostics and debugging utilities.

KippleDiagnostics A collection of common diagnostics and debugging utilities. ⚠️ The code in this library has been made public as-is for the purposes

Kipple 10 Sep 2, 2022
A web API client in Swift built using Async/Await

Web API Client A modern web API client in Swift built using Async/Await and Actors. let client = APIClient(host: "api.github.com") // Using the clien

Alexander Grebenyuk 732 Nov 25, 2022
Food Recipes App Built With Swift

Food Recipes Application This is my first IOS App. The first page is sign in and sign up page. I controll informations with regex in sign up page. If

Buse Köseoğlu 1 Dec 17, 2021
CurrencyConverter - Currency Converter App Built With Swift

CurrencyConverter Stack: Xcode 12.5.1 iOS 14.5 UIkit iOS deployment target: 13.0

Nikita Yarosh 2 Sep 4, 2022
AuroraEditor is a IDE built by the community, for the community, and written in Swift for the best native performance and feel for macOS.

AuroraEditor AuroraEditor is a IDE built by the community, for the community, and written in Swift for the best native performance and feel for macOS.

Aurora Editor 150 Nov 11, 2022
an onboarding app built in SwiftUI

hello hello is application onboarding macOS devices. Inspired by Kandji's Liftoff Logo created with Type with Pride font family Warning DO NOT USE THI

Erik Gomez 117 Oct 31, 2022
Home Assistant Native iOS Application built with SwiftUI for iOS 15+

Home Assistant - Native iOS SwiftUI Application Screenshots Disclaimer - Please read This application is mostly a not-working mockup written in SwiftU

Alessio Santoru 32 Sep 29, 2022
A developer-focused Meetup clone built with React Native

Assemblies Where Developers Connect Assemblies is an open-source mobile app built with React Native which developers can use to connect through 'assem

Build React Native 360 Aug 20, 2022
Wiggles-iOS - Beautiful Puppy adoption app built to Demonstrate the SwiftUI and MVVM Architecture

Wiggles ?? Beautiful Puppy adoption app built to Demonstrate the use of SwiftUI

Sameer Nawaz 183 Nov 15, 2022
Tofu - A simple Todo app built with SwiftUI, a REST API, and a local Realm cache

Tofu A simple Todo app built with SwiftUI, a REST API, and a local Realm cache.

Brianna Zamora 1 Feb 23, 2022
This was built during my bootcamp using SwiftUI, WebKit and an API from Hacker News

HackerNewsReader This was built during my bootcamp using SwiftUI, WebKit and an API from Hacker News. This was programmed from scratch with SwiftUI. I

Wilson Woodyard 2 Feb 25, 2022
GitHub in your pocket. Built with React Native

GitPoint GitHub in your pocket. Built with React Native. Table of Contents Introduction Features Feedback Contributors Build Process Backers Sponsors

GitPoint 4.6k Nov 15, 2022
Full featured multi arch/os debugger built on top of PyQt5 and frida

Dwarf A debugger for reverse engineers, crackers and security analyst. Or you can call it damn, why are raspberries so fluffy or yet, duck warriors ar

iGio90 1.1k Nov 22, 2022