Here is a clean, professional README.md file for your milestone repository. You can copy and paste this directly into a file named README.md in your repository.
# Milestone Tracker π
A lightweight, local-first web application designed to track career milestones, project updates, and achievements formatted cleanly like **LinkedIn posts**. It features horizontal card navigation (with keyboard and mobile swipe support) and direct integration with GitHub to update your data instantly.
## Features β¨
* **LinkedIn-Style UI:** Posts are rendered to look and feel like native LinkedIn updates (complete with headers, timestamps, post text, media, and engagement bars).
* **Horizontal Navigation:** Switch between posts effortlessly using left/right arrow keys on desktop or swipe gestures on Android/iOS.
* **In-App Creation Modal:** A minimal pop-up mimicking LinkedIn's "Create a post" interface to add new milestones on the fly.
* **Direct Git Sync:** Automatically commits additions and deletions straight to your repository's `data.json` via the GitHub REST API.
* **Dark & Light Contrast:** Dark theme wrapper with a clean, readable light theme card layout.
---
## Project Structure π
```text
milestone/
βββ .github/
β βββ workflows/
β βββ deploy.yml # Auto-deploys to GitHub Pages on push
βββ assets/
β βββ images/ # Store your milestone images here
βββ data.json # Stores timeline entries
βββ index.html # Core application logic & UI
βββ style.css # Styling and theme definitions
βββ README.md # Project documentation
- Clone the repository:
git clone [https://github.com/ATITYARAM/milestone.git](https://github.com/ATITYARAM/milestone.git)
cd milestone
- Configure your GitHub Token (for in-app syncing):
- Generate a personal access token on GitHub with
repo(Contents: Read and write) permissions. - Open
index.htmland paste your token into the configuration block:
const GITHUB_USERNAME = "ATITYARAM";
const GITHUB_REPO = "milestone";
const GITHUB_BRANCH = "main";
const GITHUB_TOKEN = "your_actual_token_here";- Run Locally:
Open
index.htmldirectly in any web browser, or serve it locally using a tool like Live Server.
This repository is pre-configured with GitHub Actions (.github/workflows/deploy.yml). Any commits made to the main branch (either manually or through the web app's creation interface) will automatically trigger a build and publish updates to GitHub Pages.