kvnloo / PhaseIWireframe

Home Page: https://lesseradmin.github.io/PhaseIWireframe/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

PhaseIWireframe

Doc coverage Platform License MIT

Docs

The documentation for this project can be found here. All of the documentation was built from in-line comments that were extracted using Jazzy

Description

Phase I Project is a project to develop an iOS Application with two main purposes:

  1. Create a noise meter that can display a noise level in decibels in real-time.

  2. Construct a 14-band dual-channel audio equalizer that is able to process audio in real-time.

I was given a wireframe design of JubiAudio Phase I as described in this spec document.

Requirements

  • iOS 10.0+
  • Xcode 8.0+
  • Swift 3.0+

Instalation

CocoaPods

CocoaPods is a dependency manager for Swift and Objective-C Cocoa projects. You can install it with the following command:

$ gem install cocoapods

CocoaPods 1.0.0+ is required to build this project.

Once, cocoapods has been installed, run the following command:

$ pod install

This will install all of the required dependencies to edit, run, and test this project. These can all be done by opening ~/PhaseIWireframe.xcuserstate using Xcode.

Creation

I started building this project by planning out the key components that it would include. Initially, after looking at the provided wireframe I decided to go with a simple design for logging in / creating an account. I also added in another option to test out the demo tools without needing to sign in. When creating the demo tools, I started out by creating a color palette. I initially browsed through coolors.co until I found a color that I liked for the background. This color ended up being Gunmetal (UIColor.BACKGROUND).

Once I had this color, I generated different shades of this color to find a set of slate colors for the application. These slate colors include Isabelline (UIColor.WHITE), Silver Chalice (UIColor.CREME), Outter Space (UIColor.CHARCOAL), Gunmetal (UIColor.BACKGROUND), and Raisin Black (UIColor.BLACK). Once these slate colors were found, I browsed through coolors.co until I found good highlight colors that I could use for GeneralUIButton, GeneralUILabel, GeneralUITextField, GeneralUIViewController, and UINavigationBar.

Here is the final color palette:

final_color_palette

Once the color palette was created I started to design custom UI Components, which can be seen below.

Here are the Custom UI Components:

custom_ui_components

Once these components were created, I started to create the layout for the application. Namely, I began designing the MVC (Model View Controller) logic to control the flow of the application.

// TODO: show the start screen, and the screens for create account, login and demo tools. Explain the design behind the demo tools. Finally include a demo for the app. A 5 minute video should suffice.

Support

Please open an issue for support.

Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.

License

This project is licensed under the MIT License. For a full copy of this license take a look at the LICENSE file.

About

https://lesseradmin.github.io/PhaseIWireframe/

License:MIT License


Languages

Language:Makefile 89.0%Language:Swift 10.9%Language:Ruby 0.1%Language:Shell 0.1%