Our core libraries (has no dependencies to any other frameworks but Apple's).
- **Jazzy** ```[sudo] gem install jazzy``` - **Brew** ```/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"``` - **Make** ```brew install make``` - **Swiftlint** ```brew install swiftlint``` ## Style Guide Following our style guide should: * Make it easier to read and begin understanding the unfamiliar code. * Make code easier to maintain. * Reduce simple programmer errors. * Reduce cognitive load while coding. * Keep discussions on diffs focused on the code's logic rather than its style. *Note that brevity is not a primary goal.* [Official Style Guide] (https://github.com/virtualstores/ios-style-guide) ## Installation ####Using as a dependency ``` swift // swift-tools-version:5.5 import PackageDescription let package = Package( name: "YourTestProject", dependencies: [ .package(url: "https://github.com/virtualstores/ios-foundation.git", from: "0.0.1") ], targets: [ .target(name: "YourTestProject", dependencies: ["VSFoundation"]) ] )
And then import wherever needed:
If you have doubts, please, check the following links:
After successfully retrieved the package and added it to your project, just import
VSFoundation and you can get the full benefits of it.
import VSFoundation // Add some example here
We have added a few helpers to make your life easier:
make buildto build the project via command line
make testto test the project via command line
make jazzyto generate the documentation and output to the
make lintto execute Swiftlint
make fixlintto auto-correct Swiftlint warnings