Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/binghuan/hackernewsjobsandroid
Hacker News Jobs Android App: Browse and search job listings from Hacker News.
https://github.com/binghuan/hackernewsjobsandroid
android kotlin
Last synced: about 2 months ago
JSON representation
Hacker News Jobs Android App: Browse and search job listings from Hacker News.
- Host: GitHub
- URL: https://github.com/binghuan/hackernewsjobsandroid
- Owner: binghuan
- Created: 2024-11-09T07:31:19.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-12T08:49:19.000Z (about 2 months ago)
- Last Synced: 2024-11-20T03:52:21.756Z (about 2 months ago)
- Topics: android, kotlin
- Language: Kotlin
- Homepage:
- Size: 1.26 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hacker News Jobs Android App
Hacker News Jobs Android App is an Android application that allows users to browse, and search job listings from the Hacker News job board. This app is built using Jetpack Compose for the UI, with local data storage managed by Room, and network data fetched via Retrofit.
- [Hacker News Jobs Android App](#hacker-news-jobs-android-app)
- [Features](#features)
- [Tech Stack](#tech-stack)
- [Installation and Usage](#installation-and-usage)
- [1. Clone the Project](#1-clone-the-project)
- [2. Configuration](#2-configuration)
- [3. Run the Project](#3-run-the-project)
- [Main Files and Code Structure](#main-files-and-code-structure)
- [Build Tools and Dependencies](#build-tools-and-dependencies)
- [Usage](#usage)
- [Illustration](#illustration)
## Features
- **Job Listings**: View a list of job posts from the Hacker News Job Board.
- **Real-time Search**: Search for jobs by title or webpage content keywords.
- **Data Fetching**: Fetch the latest job data from the Hacker News API and store it locally.
- **Webpage Preview**: Click on the job URL to open it directly in the browser.
- **Local Storage**: Store job data locally using Room for offline access.
## Tech Stack
- **Kotlin**: Main programming language for the app.
- **Jetpack Compose**: Used for building the user interface.
- **Room Database**: Used for local data persistence.
- **Retrofit**: Handles network requests to fetch job data.
- **Jsoup**: Used to retrieve webpage content from job URLs.
## Installation and Usage
### 1. Clone the Project
```bash
git clone https://github.com/yourusername/HackerNewsJobsAndroid.git
cd HackerNewsJobsAndroid
```
### 2. Configuration
Ensure all dependencies are correctly configured in the root `build.gradle` file.
### 3. Run the Project
- Open Android Studio.
- Import the project from the root directory.
- Connect an Android emulator or device, and click “Run” to start the application.
## Main Files and Code Structure
- `JobApp.kt`: Main UI code, including job search and data fetching functionality.
- `JobItem.kt`: Displays individual job listings with job details and clickable URLs.
- `JobViewModel.kt`: Manages data logic for the UI layer.
- `JobRepository.kt`: Implements data fetching, processing, and storing logic.
- `JobDao.kt` and `JobDatabase.kt`: Define and configure the Room database.
## Build Tools and Dependencies
- **Gradle**: Build tool.
- **Room**: Database library for local data persistence.
- **Retrofit**: For API calls.
- **Jsoup**: For HTML content parsing.
- **Compose Material3**: Jetpack Compose Material UI components.
## Usage
1. **Search Jobs**: Type job keywords into the search bar, press the search icon or hit enter to see matching jobs.
2. **Fetch Data**: Click the refresh button to fetch the latest jobs from Hacker News and store them locally.
3. **View Job Webpages**: Click on the job URL to open the corresponding webpage in the browser.
## Illustration
