Skip to content

Commit

Permalink
Created README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Nnamodi committed Jul 2, 2024
1 parent fcf3118 commit 3116797
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .idea/vcs.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Shopit
This shopping app is a task from HNG11 stage 1.

## Screenshots
|::::::::::::::::::::::::::::::::::::::::|::::::::::::::::::::::::::::::::::::::::|::::::::::::::::::::::::::::::::::::::::|
|:--:|:--:|:--:|
|![Products screen](screenshots/products_screen.png)|![Checkout screen](screenshots/checkout_screen.png)|![Order Successful screen](screenshots/order_successful_screen.png)|

## Features
* Shows list of products in a shop
* Add/remove products to/from cart
* Automatically sums up cart items and displays it in details
* Checkout cart items

## About

* This project was built with only native funtionalities and components and no third-party library or plugins.
* It has three screens:
* `Projects screen` shows a list of products/items (statically) in a shop.
* `Checkout screen` displays a checkout button and the products added to cart for checkout.
* `Order Successful screen` is displayed after checking out cart items.

* Optimized apk to *1.8 MB*
* Clean and Simple Material UI
<br/>

***Explore the virtualized demonstration of the release apk version [here](https://appetize.io/app/arrc6dg3fu5gxilmkmf2exgwui)***

***Or you can install the apk from below 👇🏽***

[![Shopit App](https://img.shields.io/badge/Shopit-APK-red.svg?style=for-the-badge&logo=android)](https://github.com/Nnamodi/Shopit/releases/latest/download/app.apk)

## Build Instructions
You can build the app via Android Studio, or by running the following command in your directory:

./gradle <assembleDebug | assembleRelease>

You can then find the apk file in `shopit/app/build/outputs/apk`

## Developed with
* [Jetpack Compose](https://developer.android.com/jetpack/compose) - Jetpack Compose is Android’s recommended modern toolkit for building native UI.
* [Material3](https://m3.material.io) - Google's latest design system with adaptable components and tools that support the best practices of user interface design for building beautiful apps.
* [Kotlin Coroutine](https://kotlinlang.org/docs/coroutines-overview.html) - For executing tasks asynchronously.
* [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) - Stores UI-related data that isn't destroyed on UI changes.
Binary file added screenshots/checkout_screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/order_successful_screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/products_screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3116797

Please sign in to comment.