https://github.com/prolificinteractive/devkit

Collection of commonly used swift code
https://github.com/prolificinteractive/devkit

Last synced: over 1 year ago
JSON representation

Collection of commonly used swift code

• Host: GitHub
• URL: https://github.com/prolificinteractive/devkit
• Owner: prolificinteractive
• License: mit
• Created: 2018-05-03T19:08:08.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2019-01-24T22:36:14.000Z (over 7 years ago)
• Last Synced: 2025-01-20T20:53:41.896Z (over 1 year ago)
• Language: Swift
• Size: 7.4 MB
• Stars: 1
• Watchers: 11
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# DevKit

[![CI Status](https://img.shields.io/travis/prolificinteractive/DevKit.svg?style=flat)](https://travis-ci.org/prolificinteractive/DevKit)

## Description

Collection of commonly used swift code. Documentation can be found [here](https://prolificinteractive.github.io/DevKit/).

## Usage

If you would like to integrate DevKit into your project, add the repo to your project as a git submodule.

`git submodule add https://github.com/prolificinteractive/DevKit`

In your podfile add DevKit as shown below:

```ruby

pod 'DevKit', :path => './DevKit'

```

Customizing DevKit with certain subspecs can be done as shown below. Subspecs can be found in the [documentation](https://prolificinteractive.github.io/DevKit/).

```ruby

pod 'DevKit', :path => './DevKit', :subspecs => ['Extensions/StringExtension',

                                                 'DataStructures/LinkedList']

```

## Contributing to DevKit

Adding new classes to DevKit should be added to the appropriate subspec section. Unique subspecs should include the source files, any limiting deployment targets and necessary dependencies. 

#### Sample Subspec:

```ruby

  # CalendarPermissionsValidator

  s.subspec 'CalendarPermissionsValidator' do |sp|

    sp.ios.deployment_target = '11.0'

    sp.dependency 'DevKit/Extensions/StringExtension'

    sp.dependency 'DevKit/Extensions/UIAlertControllerExtension'

    sp.dependency 'DevKit/Extensions/UIApplicationExtension'

    sp.source_files = 'DevKit/DevKit/Classes/Utility/Validators/CalendarPermissionsValidator/*'

  end

```

#### New File Documentation Template:

```swift

/// 

///

/// **Subspec: Folder/Filename**

///

/// ```

/// Code Snippet

/// ```

///

/// 

///

class myCoolClass {

  // Does something cool! 

}

```

#### Pull Request Checklist:

Once all classes and files are added to the project and documented make sure to:

* Run pod install on the example project

* Ensure the classes are added to the main DevKit Xcode workspace at ./DevKit/DevKit.xcworkspace

All new additions should be code reviewed before merging into master.

## License

![prolific](https://s3.amazonaws.com/prolificsitestaging/logos/Prolific_Logo_Full_Color.png)

Copyright (c) 2018 Prolific Interactive

DevKit is maintained and sponsored by Prolific Interactive. It may be redistributed under the terms specified in the [LICENSE] file.

[LICENSE]: ./LICENSE