Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated features, branching info, screenshot size #6

Merged
merged 1 commit into from
Dec 10, 2022
Merged

Updated features, branching info, screenshot size #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 16 additions & 26 deletions ReadMe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,36 +33,26 @@ Below are some of the key android concepts used/applied in this project:
- Shared preferences
- etc

### Project Tasks
Each feature is divided according to 3 layers; presentation, domain, data

- [ ] Home Feature (Presentation)
- [ ] Home Feature (Domain)
- [ ] Home Feature (Data)
- [ ] Transaction Feature (Presentation)
- [ ] Transaction Feature (Domain)
- [ ] Transaction Feature (Data)
- [ ] Coin List Feature (Presentation)
- [ ] Coin List Feature (Domain)
- [ ] Coin List Feature (Data)
- [ ] Coin Details Feature (Presentation)
- [ ] Coin Details Feature (Domain)
- [ ] Coin Details Feature (Data)
- [ ] Setting Feature (Presentation)
- [ ] Setting Feature (Domain)
- [ ] Setting Feature (Data)
### Main Project Tasks
Each feature is will comprise of 3 layers; presentation, domain, data

- [ ] Home Feature
- [ ] Transaction Feature
- [ ] Coin List Feature
- [ ] Coin Details Feature
- [ ] Setting Feature

## UI Designs

### Light
<img src="images/design_dark_splash.jpg" height="400" alt="Splash screen"/> <img src="images/design_light_home.jpg" height="400" alt="Home screen"/> <img src="images/design_light_coin_list.jpg" height="400" alt="Coin list screen"/>
<img src="images/design_light_coin_details.jpg" height="400" alt="Coin details screen"/> <img src="images/design_light_choose_asset.jpg" height="400" alt="Choose asset screen"/> <img src="images/design_light_buy_sell.jpg" height="400" alt="Buy - Sell screen"/>
<img src="images/design_light_settings.jpg" height="400" alt="Settings screen"/> <img src="images/design_light_app_info.jpg" height="400" alt="App info screen"/> <img src="images/design_light_loading_example.jpg" height="400" alt="Loading example screen"/>
<img src="images/design_dark_splash.jpg" height="500" alt="Splash screen"/> <img src="images/design_light_home.jpg" height="500" alt="Home screen"/> <img src="images/design_light_coin_list.jpg" height="500" alt="Coin list screen"/>
<img src="images/design_light_coin_details.jpg" height="500" alt="Coin details screen"/> <img src="images/design_light_choose_asset.jpg" height="500" alt="Choose asset screen"/> <img src="images/design_light_buy_sell.jpg" height="500" alt="Buy - Sell screen"/>
<img src="images/design_light_settings.jpg" height="500" alt="Settings screen"/> <img src="images/design_light_app_info.jpg" height="500" alt="App info screen"/> <img src="images/design_light_loading_example.jpg" height="500" alt="Loading example screen"/>

### Dark
<img src="images/design_dark_splash.jpg" height="400" alt="Splash screen"/> <img src="images/design_dark_home.jpg" height="400" alt="Home screen"/> <img src="images/design_dark_coin_list.jpg" height="400" alt="Coin list screen"/>
<img src="images/design_dark_coin_details.jpg" height="400" alt="Coin details screen"/> <img src="images/design_dark_choose_asset.jpg" height="400" alt="Choose asset screen"/> <img src="images/design_dark_buy_sell.jpg" height="400" alt="Buy - Sell screen"/>
<img src="images/design_dark_settings.jpg" height="400" alt="Settings screen"/> <img src="images/design_dark_app_info.jpg" height="400" alt="App info screen"/> <img src="images/design_dark_loading_example.jpg" height="400" alt="Loading example screen"/>
<img src="images/design_dark_splash.jpg" height="500" alt="Splash screen"/> <img src="images/design_dark_home.jpg" height="500" alt="Home screen"/> <img src="images/design_dark_coin_list.jpg" height="500" alt="Coin list screen"/>
<img src="images/design_dark_coin_details.jpg" height="500" alt="Coin details screen"/> <img src="images/design_dark_choose_asset.jpg" height="500" alt="Choose asset screen"/> <img src="images/design_dark_buy_sell.jpg" height="500" alt="Buy - Sell screen"/>
<img src="images/design_dark_settings.jpg" height="500" alt="Settings screen"/> <img src="images/design_dark_app_info.jpg" height="500" alt="App info screen"/> <img src="images/design_dark_loading_example.jpg" height="500" alt="Loading example screen"/>

## Getting Started

Expand All @@ -83,8 +73,8 @@ You can pick a thing to do from the tasks list provided above and work on it.<br
Observe the following in order to have your PR merged successfully.
- Create branches from the `dev` branch
- Create a PR to the `dev` branch
- Prefix branch name with it purpose ie `feature`, `bugfix`, `hotfix`
- For feature branches use the following naming conventions `feature_<feature-name>_<layer ie domain/data/presentation>`
- Prefix branch name with it purpose ie `feature_`, `bugfix_`, `hotfix_`
- For feature branches use the following naming conventions `feature_<feature-name>`

Feel free to check the [issues page](../../issues/) or [discussions page](../../discussions).

Expand Down