Pixplicity's

Project (Code)name
===

Android/iOS/Tensorflow/Whatever project for the _Codename_ app for _Client_. Based on the work from project _Research project_.

This app does lorem ipsum dolor sit amet.

## Quickstart

Examples:

1. Clone repo
2. Run from Android Studio


## Installation

#### Requirements

Minimum Android Studio, minimum hardware requirements, Kotlin, related projects, etc.

#### Running the project

Examples:

1. Clone repo
2. Run from Android Studio
3. Execute `run.ssh`
4. `cd` into a subfolder
5. `php -S localhost:8888 ./something.php`.

#### Branches

The branch `feature/yellow` contains all the customisations for the yellow version. The `develop` branch is the original blue.

#### Product flavors

Flavor *Yellow* is a special yellow version of the project. The *Blue* flavor is the same but way more blue.

#### Building and deploying

Builds are automatically deployed to Beta channel when you push to `develop`.

Make sure to send clients the yellow version of the main app and the blue version of the other app.


## Relevant information

#### API

There are two important API endpoints used by this project:

- `https://example.com/some/kind/of/important/example` - which is the most important example ever.
- `https://example.com/some/kind/of/test/example` - test endpoint which is used by the lorem ipsum.

The full documentation is [here](https://apidocumentation.api/example/lorem).

#### Translations

Managed [here](https://translation.service/projects/lorem) by Lorem Ipsum Latin Translations Inc.

#### Issue tracker

[Internal issue tracker](https://jira/example/lorem)
[Trello board for clients](https://trello.com/ipsum)

#### Misc. links

The underlying algorithm is explained [here](https://algorithms.explained/lorem).


## Licenses

This project uses several libraries that are licensed under the Apache 2.0 License.

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog][keepalog],
and this project adheres to [Semantic Versioning][semver].


## 1.0.20 (v10020) - Upcoming

### Added

- New feature X [PIX-12]

### Changed

- Thing A is no longer B, swapped with C instead for performance [PIX-345]

### Fixed

- XYZ appeared when it shouldn't [PIX-100]
- Fixed crash for users who ABC [PIX-101]


## 1.0.0 (v10019) - 2020-10-31

### Fixed

- Added missing CHANGELOG.md