Monotone

English · 中文

Report Bug · Request Feature

Monotone is a Modern Mobile Application, integrated with powerful Unsplash API provided by Unsplash. It implemented almost all features including viewing, searching, collecting photos. And other features, such as profile, license, FAQ are supported as well.

This is an un-official application, exploring the feasibility of some conceptions is the goal of this project. Written in Swift, triggered by RxSwift, draw responsive constraints using SnapKit.

If you like this project or inspired by any ideas of this project, please star it without any hesitation. (ヽ(✿ﾟ▽ﾟ)ノ)

Table of Contents

1. Overview
2. Development Progress
   • Features
   • Tasks
3. Getting Started
   • Prerequisites
   • Installation
4. Dependencies
5. Sturcture
6. Design
7. About Unsplash
8. Contributing
   • How to Participate in
9. Contact on Me
10. License

Overview

Development Progress

Features

• Write Interfaces Programmatically
• Dark Mode Support
• Animation Effects
• Localization
• Powered by Unsplash API
• More...

Tasks

Currently supported tasks:

Getting Started

This application uses Cocoapods to manage dependencies. Please refer to Cocoapods Offical Website to install & configure(If you already installed Cocoapods, skip this).

Prerequisites

Monotone is trigged by Unsplash API . The very first thing must be done is applying a pair of OAuth key to run it.

1. Visit Unsplash, sign up then sign in.(If you already have an account, skip this).
2. Visit Unsplash Application Registration Platform agree with terms and create a new application, the application name and description can be anything.
3. After the application was created，it will redirect to the application details page automatically (Also can be found from https://unsplash.com/oauth/applications). At Redirect URI & Permissions - Redirect URI section, input monotone://unsplash, make sure all authentication options are checked, just like the image shown below.

4. After the work is finished, check ”Access Key“ and ”Secret Key“ on this page, they will be used soon.

Installation

1. Execute the following commands in the terminal:

# Clone to a local folder
git clone https://github.com/Neko3000/Monotone.git

# Direct to Project folder
cd Monotone

# Install Pods
pod install

2. Under Monotone folder, duplicate config_debug.json file，and rename it to config.json(This file is ignored by .gitignore)；
3. Open config.json ，input your ”Access Key“ and ”Secret Key“，they will be copyed to APP folder when running.(For more information, please refer to the content in Project->Build Phases->Run Script and APPCredential.swift )；
4. Done，command + R。

Dependencies

For more information，please check Podfile。

Project Structure

The basic structure of this project.

Monotone 
├── Monotone
│   ├── /Vars  #Global Variables
│   ├── /Enums  #Enums (Includes some dummy data)
│   ├── /Application
│   │   ├── AppCredential  #Authentication Credential
│   │   ...
│   │   └── UserManager  #User Managment
│   ├── /Utils  #Utils
│   │   ├── /BlurHash  #Photo Hash
│   │   ├── ColorPalette  #Global Colors
│   │   ├── AnimatorTrigger  #Animation Effects
│   │   └── MessageCenter  #Message Notification
│   │── /Extension  #Extensions
│   │── /Services  #Services
│   │   ├── /Authentication  #Requests of Authentication
│   │   └── /Network  #Requesets of Data
│   │── /Components  #View Classes
│   │── /ViewModels  #View Models
│   │── /ViewControllers  #View Controllers
│   │── /Models  #Data Models
│   │── /Coordinators  #Segues
│   └── /Resource  #Resource
└── Pods

Designing

The interface you are seeing are all designed by Addie Design Co. They shared this document, everyone can free download it and use it. Those design elements and their level of completion are astonishing. This application would not be here without this design document.

Thanks again to Addie Design Co and this beautiful design document.

About Unsplash

Unsplash is a website dedicated to sharing high-quality stock photography under the Unsplash license. All photos uploaded by photographers will be organized and archived by editors.

And this website is one of my favorites, admired for its artistic, the spirit of sharing.
You will find my home page here. (Not updated frequently since 2020)

Contributing

Limited by data Unsplash API provides, some parts of this application only finished their styles and layouts(Almost in store, explore, etc). If the API provides more detailed data on these parts in the future, we will add new features as soon as possible.

Meanwhile, focusing on the current application, we will improve it continuously.

How to Participate in

If you are an experienced mobile application developer and want to improve this application. You are welcomed to participate in this open-source project. Practice your ideas, improve even refactor this application.

Follow standard steps:

1. Fork this repo;
2. Create your new Branch (git checkout -b feature/AmazingFeature);
3. Add Commit (git commit -m 'Add some AmazingFeature');
4. Push to remote Branch (git push origin feature/AmazingFeature);
5. Open a Pull Request.

For anyone, open an issue if you find any problems. PRs are welcome.

Contact on Me

E-mail: [email protected]
Blog: chienerrant.com
Weibo: @一只妖艳的绀色布

License

Distributed under the MIT License.
See LICENSE for more information.