Alicerce 🏗

from Portuguese:

noun • [ masculine ] /ali’sɛɾsɪ/

groundwork, foundation, basis

What is it? 🤔

Ever felt that you keep repeating yourself every time you start a new project? That you would like to have all those useful utils and helpers you love already available? We felt that way too! Thus, Alicerce was born. 🏗

Alicerce is a framework that aims to serve as a starting point for iOS applications, by providing the foundations for many of the common functionalities a modern application requires, as well as be a repository for those small utils and helpers that make our life easier.

It is designed with an MVVM architecture in mind, but you'll find most components are architecture agnostic.

Main features ✨

1. Analytics 🔍
2. Deep Linking 🔗
3. Logging 📝
4. Network 🌍
5. Persistence 💾
6. Performance Metrics 📈
7. Utils ⚙️
8. UI 📲

Documentation 📄

All the documentation can be found in the Documentation folder:

1. Network
2. more coming soon...

Examples 👀

TODO

Installation 🔧

Alicerce supports iOS 9.0+ and requires Xcode 10+.

For Xcode 9.3 (Swift 4.0) compatibility, Alicerce 0.3.0 should be used.

CocoaPods

If you use CocoaPods to manage your dependencies, simply add Alicerce to your Podfile:

pod 'Alicerce', '~> 0.5'

Carthage

If you use Carthage to manage your dependencies, simply add Alicerce to your Cartfile:

github "Mindera/Alicerce" ~> 0.5

If you use Carthage to build your dependencies, make sure you have added Alicerce.framework to the "Linked Frameworks and Libraries" section of your target, and have included them in your Carthage framework copying build phase.

Swift Package Manager

If you use Swift Package Manager, simply add Alicerce as a dependency of your package in Package.swift:

.Package(url: "https://github.com/Mindera/Alicerce.git", majorVersion: 0, minor: 5),

git Submodule

1. Add this repository as a submodule.
2. Drag Alicerce.xcodeproj into your project or workspace.
3. Link your target against Alicerce.framework.
4. If linking against an Application target, ensure the framework gets copied into the bundle. If linking against a Framework target, the application linking to it should also include Alicerce.

Setup

Setting up the project for development is simple:

1. Clone the repository.
2. Retrieve the project dependencies using one of the following commands from the project root directory:
   • if you have Carthage installed: carthage checkout
   • or: git submodule update --init --recursive
3. Open Alicerce.xcworkspace
4. Build Result-iOS scheme
5. Build Alicerce scheme

Contributing 🙌

See CONTRIBUTING.

License

Alicerce is Copyright (c) 2016 - 2018 Mindera and is available under the MIT License. It is free software, and may be redistributed under the terms specified in the LICENSE file.

About

With ❤️ from Mindera 🤓