{"id":42501268,"url":"https://github.com/pace11/readable","last_synced_at":"2026-01-28T13:07:54.149Z","repository":{"id":307350598,"uuid":"1029203549","full_name":"pace11/readable","owner":"pace11","description":"Simple News APP with integration using NYT (New York Times) API","archived":false,"fork":false,"pushed_at":"2025-07-30T18:32:51.000Z","size":38,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-07-30T21:04:29.133Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pace11.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-30T17:15:30.000Z","updated_at":"2025-07-30T18:32:54.000Z","dependencies_parsed_at":"2025-07-30T21:04:43.546Z","dependency_job_id":"efffa0a3-9239-43e6-b371-692e2624515c","html_url":"https://github.com/pace11/readable","commit_stats":null,"previous_names":["pace11/readable"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/pace11/readable","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pace11%2Freadable","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pace11%2Freadable/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pace11%2Freadable/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pace11%2Freadable/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pace11","download_url":"https://codeload.github.com/pace11/readable/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pace11%2Freadable/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28845927,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-28T13:02:32.985Z","status":"ssl_error","status_checked_at":"2026-01-28T13:02:04.945Z","response_time":57,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-28T13:07:53.322Z","updated_at":"2026-01-28T13:07:54.137Z","avatar_url":"https://github.com/pace11.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e📖 READable\u003c/h1\u003e\n\u003cp align=\"center\"\u003eSimple News APP with integration using NYT (New York Times) API\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://img.shields.io/badge/React-20232A?style=for-the-badge\u0026logo=react\u0026logoColor=61DAFB\" /\u003e\n\u003cimg src=\"https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge\u0026logo=typescript\u0026logoColor=white\" /\u003e\n\u003cimg src=\"https://img.shields.io/badge/bun-282a36?style=for-the-badge\u0026logo=bun\u0026logoColor=fbf0df\" /\u003e\n\u003cimg src=\"https://img.shields.io/badge/Vite-B73BFE?style=for-the-badge\u0026logo=vite\u0026logoColor=FFD62E\"  /\u003e\n\u003cimg src=\"https://img.shields.io/badge/shadcn%2Fui-000000?style=for-the-badge\u0026logo=shadcnui\u0026logoColor=white\" /\u003e\n\u003cimg src=\"https://img.shields.io/badge/Docker-2CA5E0?style=for-the-badge\u0026logo=docker\u0026logoColor=white\" /\u003e\n\u003cimg src=\"https://img.shields.io/badge/Docker%20Compose-2496ED?style=for-the-badge\u0026logo=docker\u0026logoColor=white\" /\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\u003cimg src=\"./readable-logo.png\" width=\"300\" /\u003e\u003c/p\u003e\n\n## 🕸️ Stack\n\n- Reactjs + Typescript ✅\n- Shadcn (UI Library) ✅\n- Bun ✅\n- Vite ✅\n- Zustand (Store Management) ✅\n- Tanstack Query (Client Data Fetching) ✅\n- Tanstack Router (Filesystem Routing) ✅\n- Github Actions and Docker (Deployment, Infra) ✅\n\n## ✏️ Script\n\n| Script Name       | Description                  | Command                   |\n| ----------------- | ---------------------------- | ------------------------- |\n| `dev`             | Start development server     | `bun run dev`             |\n| `generate-routes` | Generate tanstack routes gen | `bun run generate-routes` |\n| `build`           | Build for production         | `bun run build`           |\n| `preview`         | Preview production build     | `bun run preview`         |\n| `lint`            | Lint codebase                | `bun run lint`            |\n\n## 🌟 Features\n\n- Keyword-based search functionality implemented ✅\n- Suggestions appear while typing, sourced from extracted keywords in the API response ✅\n- Users can bookmark articles, stored locally on browser using Zustand ✅\n\n## ▶️ How to run\n\n- Clone this repository\n- Makesure you already install bun on globally\n- Install dependency first with `bun install`\n- Run development mode with `bun run dev`\n\n## 🚀 How to deploy\n\n- Branching Strategy with Git Flow\n- First, Create new branch with prefix `feature_*` example `feature_bookmark`\n- Open Pull Request and target merging branch is `master`\n- Put the title and description and then please wait until finished reviewing\n- Reviewing is finished, Merging `_feature_*` branch into `master` and deployment flow is ready to go 🏃\n- Flow Deployment 👇👇👇\n\n1. Trigger GitHub Actions when push branch `master`\n\n```yaml\non:\n  push:\n    branches:\n      - master\n```\n\n2. Setup Docker Buildx, Login Docker Hub, Build and Push to Docker Hub\n\n```yaml\nsteps:\n    - name: Checkout repo\n    uses: actions/checkout@v4\n\n    - name: Set up Docker Buildx\n    uses: docker/setup-buildx-action@v3\n\n    - name: Login to Docker Hub\n    uses: docker/login-action@v3\n    with:\n        username: ${{ secrets.DOCKER_USERNAME }}\n        password: ${{ secrets.DOCKER_TOKEN }}\n\n    - name: Build and Push to Docker Hub\n    uses: docker/build-push-action@v5\n    with:\n        context: .\n        file: ./Dockerfile\n        push: true\n        tags: ${{ secrets.DOCKER_USERNAME }}/readable-app:latest\n        build-args: |\n        VITE_NEWS_API_URL=${{ secrets.VITE_NEWS_API_URL }}\n        VITE_NEWS_API_KEY=${{ secrets.VITE_NEWS_API_KEY }}\n```\n\n3. SSH to Production Server and Pull Latest Changes\n\n```yaml\nsteps:\n    - name: SSH to Production Server and Pull Latest Changes\n    uses: appleboy/ssh-action@master\n    with:\n        host: ${{ secrets.HOST }}\n        username: ${{ secrets.USERNAME }}\n        password: ${{ secrets.PASSWORD }}\n        port: ${{ secrets.PORT }}\n        script: |\n        cd pace-app-neo\n        sudo docker pull ${{ secrets.DOCKER_USERNAME }}/readable-app:latest\n        sudo docker compose up -d readable-app\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpace11%2Freadable","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpace11%2Freadable","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpace11%2Freadable/lists"}