/AppRepositoryTemplate

The easiest way to start a new application project without any manual configuration

Primary LanguageSwiftMIT LicenseMIT

Lint Status iOS Status tvOS Status macOS Status watchOS Status

AppRepositoryTemplate

AppRepositoryTemplate is the starting point of every application made by Atelier Socle. After a lot of doing and redoing project setup, configuration, ... we finally decided to make our own template to have a project / repository with our full basic configuration with just a few command lines. It includes:

  • A script to make your repository ready to work in less than 5 minutes
  • An auto-generated xcodeproj (thanks to XcodeGen) including: targets for iOS, tvOS, macOS, watchOS, and Notification {Service,Content) app extension.
  • Basic environment setup including: Debug, Release, but also Beta and AdHoc + their xcconfig files, and custom app icons
  • Firebase configuration per environment ready to go (once you have updated the firebase's plists)
  • A SwiftGen configuration** for the iOS target including strings, images, storyboards, and segues
  • SwiftLint ready to warn with its configuration file
  • A Gemfile to easily handle gems dependencies
  • A Mintfile to easily handle handle swift tools
  • All the basic documentation: README, CHANGELOG, ...
  • Github Actions setup to build, tests,
  • A fastlane configuration for deployment
  • ...

Note: Since it's just a template, it will just give basics setup, it's the developer work to finish the configuration before finalizing it's application.

Usage

Have a full repository setup ready to be used in a few steps:

  • Run sh prepare_repository.sh {REPO_NAME} {NEW_REPO_PATH}
  • Start working on your app!

From here, you will have only to configure the project to match your need:

  • Update the xcconfig files to put your bundle identifiers, versions, team id, ...
  • Update the fastlane configuration to match your apple id, team id, ...
  • Update the APNs script by replacing the AuthKey and add your information
  • Read the new README to start working on your project
  • Remove targets that you won't need in the XcodeGen configuration: ``
  • ...

Contributions

Pull requests and issues are always welcome. Please open any issues and PRs for bugs, features, or documentation. Note that we keep the right to reject any PRs that we don't feel to integrate in future Atelier Socle project.

License

AppRepositoryTemplate is licensed under the MIT license. See LICENSE for more info.