{"id":50938668,"url":"https://github.com/corychainsman/explainers","last_synced_at":"2026-06-17T11:37:59.560Z","repository":{"id":344676294,"uuid":"1182681570","full_name":"corychainsman/explainers","owner":"corychainsman","description":null,"archived":false,"fork":false,"pushed_at":"2026-03-15T23:40:47.000Z","size":28,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-16T08:29:08.211Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/corychainsman.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-03-15T20:47:36.000Z","updated_at":"2026-03-15T23:40:52.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/corychainsman/explainers","commit_stats":null,"previous_names":["corychainsman/explainers"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/corychainsman/explainers","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corychainsman%2Fexplainers","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corychainsman%2Fexplainers/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corychainsman%2Fexplainers/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corychainsman%2Fexplainers/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/corychainsman","download_url":"https://codeload.github.com/corychainsman/explainers/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corychainsman%2Fexplainers/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34447266,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-17T02:00:05.408Z","response_time":127,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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-06-17T11:37:58.707Z","updated_at":"2026-06-17T11:37:59.551Z","avatar_url":"https://github.com/corychainsman.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Explainers\n\nA React gallery app that serves as a jumping-off point for multiple interactive pages. The home screen shows a grid of cards — one per page — and clicking a card navigates to that page. New pages are added incrementally; placeholders hold the spot until they're built out.\n\n**Live site:** https://corychainsman.github.io/explainers/\n\n---\n\n## Stack\n\n| Tool | Role |\n|---|---|\n| [Bun](https://bun.sh) | Runtime \u0026 package manager |\n| [Vite](https://vitejs.dev) | Dev server \u0026 bundler |\n| [React 18](https://react.dev) | UI framework |\n| [React Router v6](https://reactrouter.com) | Client-side routing (HashRouter) |\n| [gh-pages](https://github.com/tschaub/gh-pages) | GitHub Pages deployment |\n\nHashRouter is used (URLs like `/#/page-name`) so GitHub Pages works without any server config.\n\n---\n\n## Local development\n\n```bash\nbun install      # install dependencies\nbun run dev      # start dev server at http://localhost:5173\nbun run build    # production build → dist/\nbun run deploy   # build + push to gh-pages branch (publishes to GitHub Pages)\n```\n\n---\n\n## How to add a new page\n\nAdding a page is a three-step process:\n\n### Step 1 — Register the card in the gallery\n\nOpen `src/pages/Home.jsx` and add an entry to the `pages` array:\n\n```js\nconst pages = [\n  // existing entries...\n  {\n    id: 7,                        // must be unique\n    title: 'My New Page',         // displayed as the card heading\n    description: 'What it does',  // one-line description shown on the card\n    path: '/my-new-page',         // URL hash path (must start with /)\n  },\n]\n```\n\n### Step 2 — Create the page component\n\nCreate a new file at `src/pages/MyNewPage.jsx`:\n\n```jsx\nfunction MyNewPage() {\n  return (\n    \u003cdiv\u003e\n      \u003ch1\u003eMy New Page\u003c/h1\u003e\n      {/* your interactive content here */}\n    \u003c/div\u003e\n  )\n}\n\nexport default MyNewPage\n```\n\n### Step 3 — Add a route\n\nOpen `src/App.jsx` and import your component, then add a `\u003cRoute\u003e`:\n\n```jsx\nimport MyNewPage from './pages/MyNewPage.jsx'\n\n// inside \u003cRoutes\u003e:\n\u003cRoute path=\"/my-new-page\" element={\u003cMyNewPage /\u003e} /\u003e\n```\n\nThat's it. The card on the home screen will now navigate to your new page.\n\n---\n\n## Project structure\n\n```\nexplainers/\n├── index.html                  # HTML entry point\n├── vite.config.js              # Vite config (sets base path for GitHub Pages)\n├── package.json                # Scripts and dependencies\n└── src/\n    ├── main.jsx                # React root mount\n    ├── App.jsx                 # Router setup — add new \u003cRoute\u003e entries here\n    ├── App.css                 # Global reset/base styles\n    ├── pages/\n    │   ├── Home.jsx            # Gallery grid — add new page entries here\n    │   ├── Home.css            # Gallery layout styles\n    │   └── [YourPage].jsx      # One file per interactive page\n    └── components/\n        ├── PageCard.jsx        # Individual gallery card (title, description, button)\n        └── PageCard.css        # Card styles\n```\n\n---\n\n## Deployment\n\nThe site is hosted on GitHub Pages from the `gh-pages` branch. To publish:\n\n```bash\nbun run deploy\n```\n\nThis runs `vite build` then pushes the `dist/` folder to the `gh-pages` branch. GitHub Pages serves that branch automatically. The `base: '/explainers/'` setting in `vite.config.js` ensures all asset paths are correct under the `/explainers/` subpath.\n\n---\n\n## For AI agents\n\nSee [AGENTS.md](./AGENTS.md) for a precise, machine-readable description of how to add pages to this repo.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcorychainsman%2Fexplainers","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcorychainsman%2Fexplainers","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcorychainsman%2Fexplainers/lists"}