Skip to content

Commit

Permalink
Update README By Adding CI/CD Pipeline
Browse files Browse the repository at this point in the history
  • Loading branch information
AhmedOmara14 authored Jul 1, 2024
1 parent c097415 commit fcef80a
Showing 1 changed file with 16 additions and 17 deletions.
33 changes: 16 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,15 @@
<h1 align="center">News App</h1>

<h2>Project Overview</h2>

<p>The News App is a dynamic platform that offers a curated list of news articles. Users can easily search for news articles by title and access detailed information about each article.</p>

<h2>Key Features</h2>

<ul>
<li><strong>Modular Design:</strong> Implemented modularization by creating separate data and domain modules, enhancing code organization and maintainability. These modules are seamlessly integrated into the main project.</li>
<li><strong>Persistent Storage:</strong> Utilized Room Database to effectively store and manage articles. This enables smooth unit testing of data operations, ensuring data integrity and reliability.</li>
</ul>

<h2>Technology Stack</h2>

<p>The News App is built using cutting-edge technologies and architecture to deliver a seamless user experience:</p>

<ul>
<li><strong>UI:</strong> JetPack Compose </li>
<li><strong>UI:</strong> JetPack Compose </li>
<li><strong>Language:</strong> Kotlin</li>
<li><strong>Networking (Master Branch):</strong> Retrofit</li>
<li><strong>Networking (Ktor Client Branch):</strong> Ktor</li>
Expand All @@ -26,18 +19,24 @@
<li><strong>Testing:</strong> Comprehensive unit testing</li>
<li><strong>Database:</strong> Room</li>
</ul>
Branches:

**Branches:**
- [Master Branch (Retrofit)](#)
- [Ktor Client Branch (Ktor)](#)
- [Koin Branch (Koin)](#)


Master Branch (Retrofit)
Ktor Client Branch (Ktor)
Koin Branch (Koin)
<h2>Continuous Integration</h2>
<p>We have implemented an Android pipeline CI to ensure code quality and streamline the development process. The pipeline includes the following stages:</p>
<ul>
<li><strong>Lint:</strong> Analyzes the code for potential errors and ensures it adheres to coding standards.</li>
<li><strong>Unit Test:</strong> Runs unit tests to validate the functionality of individual components.</li>
<li><strong>Static Code Analysis:</strong> Performs static analysis to identify potential issues in the codebase.</li>
<li><strong>Package:</strong> Packages the application and prepares it for deployment.</li>
</ul>
<div align="center">
<img src="https://github.com/AhmedOmara14/NewsApp/assets/60369343/d5505e81-4029-48fd-86ee-d1089c54c84c" alt="Android Pipeline">
</div>
<h2>Screenshots</h2>

<div align="center">
<img src="https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExejBmcjlmeXpza3UyNzRkcWQxNjcxdGFycmpqNHB2YWx1MHMzdG5zZCZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/VYj54iS1FKNiHfiNV1/giphy.gif" alt="News App Screenshot">
</div>

<p>Experience the future of news consumption with the News App, where innovation meets information. Stay informed effortlessly.</p>

0 comments on commit fcef80a

Please sign in to comment.