Skip to content

This project is for checking and formatting readme file for project use

Notifications You must be signed in to change notification settings

sulaiman-mlbd/DemoReadMeFile

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 

Repository files navigation

Kireipass

Kireipass is a client app of GMO Kumapon Co. Ltd which provide beauty treatment for people.

Platform Swift Version CocoaPods Compatible

There are many people who are interested in beauty treatment for various reasons but it is difficult for them to do it because they have anxiety. Kirei Pass is a service that will ease the anxiety and allow them to experience beauty treatment more easily.

Requirements

  • iOS 11.0+
  • Xcode 10.0+

Project Setup

Clone the repository:

git clone git@github.com:monstar-lab/kireipass_iOS.git

Open directory in terminal

  cd path/kireipass_iOS/

Install bundler if not installed

Run the following command in terminal on our project to install the dependencies

  sh setup.sh

or

  bundle install --path vendor/bundle
  bundle exec pod install
  Pods/SwiftGen/bin/swiftgen

Now, our project is ready to run on Xcode. Open project-name.xcworkspace file for using this project

Project Structure

/<Project Name>
	/Common				# Common loader, error message view etc.
		/Name 1
		/Name 2
	/Data
 		/PersistanceManager 	# Core data, file base data storage manager here
		/Network		# Networking module for this project , handle all networking operation from here
			/Parameter	# Models - From which data will be passed to server from different CRUD operation
			/Response	# Models - Response from server will be parsed as Response type model and will be 						passed to upper layer
	/Dev 				# Dev environmet specific contents
	/Features 			# Contains all screen with ViewController, ViewModel, Storyboard files
		/Feature A		# Contains ViewController, ViewModel, Storyboard for Feature A
		/Feature B
		.....
	/Flows 				# Handle App Navigation with many flow using Coordinator pattern (uses RxFlow) 
	/Model 				# Contains model files 
	/Prod 				# Production environmet specific contents
	/Protocols			# Protocols used in different classes
	/Resources			# Contains assets + some other resources for this project
	/Services			# Contains Services used by different ViewControllers of this 
	/Stg				# Staging environmet specific contents
	/Utility 			# Hold some utility classes like Keymanager etc.
		

Note

Storyboard

  • set colors with sRGB

RxSwift

  • use onNext instead of onError on Subject
func requestSomething() -> Observable<Result<ResponseType, ErrorType>> {
    let subject = PublishSubject<Result<ResponseType, ErrorType>>

    someRequest() { response, error in
        if let error = error {
            subject.onNext(Result.failure(error))
            return
        }

        subject.onSuccess(Result.success(response))
    }

    return subject
}

About

This project is for checking and formatting readme file for project use

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published