QuotiNews

A News App with Jetpack Compose!
Screenshots · Requirements · Architecture · Technologies · License

QuotiNews is an Android App built with Jetpack Compose that consumes the News API with the purpose of showing the news of the day, breaking news, news by section (sports / technology / etc) and allows the user to search for a new.

It is currently under development.

🕹️ UI/UX 🕹️

This section is all about detailing the UI/UX of your project, their themes and animations.

The animations and interactive content from this section should be placed inside of readme-assets/gifs.

Animation 1	Animation 2	Animation 3	Animation 4

(back to top)

📷 Screenshots 📷

Here you can add your projects's screenshots, reference the Design System used (Material / Cupertino / Custom) and the different UI Modes (Night / Dark).

The screenshots from this section should be placed inside of readme-assets/images

Screen 1	Screen 2	Screen 3

Screen 4	Screen 5	Screen 6

(back to top)

📝 Requirements 📝

The current project uses the News API in order to search and provide news information. Hence, in order to run this project properly it is necessary to specify such API key in the local.properties file, in the following way:

NEWS_API_KEY=029cs8873jd783SomeApiKeyValue

These fields are used in the build.gradle file from the app:module in order to generate BuildConfig fields.

// Reading the `NEWS_API_KEY` field from local.properties
buildConfigField "String", "API_KEY", "\"${properties.getProperty("NEWS_API_KEY")}\""

(back to top)

🛠 Architecture 🛠

This section should comment the Architecture used in the project.

(back to top)

🦾 Technologies 🦾

QuotiNews uses many of the top libraries and tools in the Android Development World, like:

• Jetpack Compose: The Modern Declarative UI Toolkit for Building Native Android UIs.
• Material Design 2: An adaptable system of guidelines, components, and tools that support the best practices of user interface design.
• Dagger Hilt: A static, compile-time dependency injection framework for both Java and Android built on the JSR-330.
• Coil: An image loading library for Android backed by Kotlin Coroutines.
• Retrofit: Square's type-safe HTTP Client.
• Room: A persistence library which provides an abstraction layer over SQLite.

(back to top)

🪶 Author(s) 🪶

Wami Ikechukwu - @wamiikechukwu

Fifi Degarr - @cerver1

Jon Areas - @jxareas

📜 License 📜

MIT License

Copyright (c) 2023 Wami Ikechukwu

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

(back to top)