https://github.com/zomato/sushi-ui-android

Sushi Design System - UI Kit for Android apps
https://github.com/zomato/sushi-ui-android

android

Last synced: about 1 month ago
JSON representation

Sushi Design System - UI Kit for Android apps

• Host: GitHub
• URL: https://github.com/zomato/sushi-ui-android
• Owner: Zomato
• License: apache-2.0
• Created: 2022-01-28T11:50:31.000Z (almost 3 years ago)
• Default Branch: dev
• Last Pushed: 2022-03-01T06:44:58.000Z (almost 3 years ago)
• Last Synced: 2024-05-10T22:02:36.261Z (8 months ago)
• Topics: android
• Language: Kotlin
• Homepage:
• Size: 4.81 MB
• Stars: 103
• Watchers: 10
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        


  

# Sushi Design System

⚡️ Android UI Kit ⚡️


Application is available here:



  

[![Downloads Badge](https://img.shields.io/endpoint?logo=google-play&url=https://api-playstore.rajkumaar.co.in/downloads?id=com.zomato.sushiapp&color=success)](https://play.google.com/store/apps/details?id=com.zomato.sushiapp) [![Rating Badge](https://img.shields.io/endpoint?logo=google-play&url=https://api-playstore.rajkumaar.co.in/rating?id=com.zomato.sushiapp&color=success)](https://play.google.com/store/apps/details?id=com.zomato.sushiapp) 

  

Latest release:

  

![Version Badge](https://img.shields.io/endpoint?color=blue&url=https://api-playstore.rajkumaar.co.in/version?id=com.zomato.sushiapp)



## Usage

The master branch is being used for release and dev is the default branch.

### Installation

This package is available via Github Package Registry. To use this, follow these steps.

Add the Github Maven repository and the dependency in your app's build.gradle

```groovy

repositories {

    // ... google(), jcenter() etc

    maven {

        url "https://maven.pkg.github.com/Zomato/sushi-ui-android"

        credentials(HttpHeaderCredentials) {

            name = "Authorization"

            value = "token ${System.getenv("GITHUB_TOKEN")}"

        }

        authentication { header(HttpHeaderAuthentication) }

    }

}

dependencies {

    // ... other dependencies

    implementation "com.zomato.sushilib:sushilib-android:${latest_version}"

}

```

> NOTE: Make sure you have the `GITHUB_TOKEN` environment variable set. This token should have `read:packages` enabled.

## Documentation

A delicious UI Kit to build Android apps. Made with ❤ by Zomato 


## Testing & Coverage

Run all tests and get coverage report

```shell 

./gradlew jacocoTestReport

```

## Publishing

To publish this package, go to Actions tab of the repo and select "Version Bump CI" workflow. This workflow has to be manually triggered by clicking "Run Workflow" button. It will create a PR on "master" branch which after merge will generate and publish a new package.

## License

```

Copyright 2022 Zomato Limited.

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

```