{"id":13433865,"url":"https://github.com/hackclub/theme-starter","last_synced_at":"2026-04-29T16:02:15.857Z","repository":{"id":37953856,"uuid":"254164465","full_name":"hackclub/theme-starter","owner":"hackclub","description":"🐤 A sample Next.js project for getting started with MDX, Theme UI, \u0026 Hack Club Theme.","archived":false,"fork":false,"pushed_at":"2023-06-26T19:59:09.000Z","size":614,"stargazers_count":86,"open_issues_count":5,"forks_count":19,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-14T05:10:09.496Z","etag":null,"topics":["mdx","nextjs","nextjs-starter","theme-ui"],"latest_commit_sha":null,"homepage":"https://theme.hackclub.com/","language":"JavaScript","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/hackclub.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}},"created_at":"2020-04-08T18:08:04.000Z","updated_at":"2024-12-19T04:52:54.000Z","dependencies_parsed_at":"2024-11-08T21:19:08.772Z","dependency_job_id":"44631fb0-cc5b-48a8-b715-2bb8a44145e0","html_url":"https://github.com/hackclub/theme-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackclub%2Ftheme-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackclub%2Ftheme-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackclub%2Ftheme-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackclub%2Ftheme-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hackclub","download_url":"https://codeload.github.com/hackclub/theme-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240079641,"owners_count":19744727,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["mdx","nextjs","nextjs-starter","theme-ui"],"created_at":"2024-07-31T02:01:38.478Z","updated_at":"2026-04-29T16:02:10.813Z","avatar_url":"https://github.com/hackclub.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Hack Club Theme Starter\n\nA sample [Next.js] project for getting started with [MDX], [Theme UI], \u0026 [Hack Club Theme].\n\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/git?s=https%3A%2F%2Fgithub.com%2Fhackclub%2Ftheme-starter\u0026repo-name=theme-project)\n\n[next.js]: https://nextjs.org\n[mdx]: https://mdxjs.com\n[theme ui]: https://theme-ui.com\n[hack club theme]: https://github.com/hackclub/theme\n\n## Usage\n\n1. Import this repo to your coding environment of choice. Download it, `git clone`, or use the GitHub import on Glitch/Repl.it.\n2. `yarn` to install dependencies.\n3. `yarn dev` to start your server.\n4. Start adding your own pages \u0026 components in their respective directories.\n\n## Configuration\n\n### Theme switcher\n\nWe’ve included an example theme switcher component at `components/color-switcher.js`,\nwhich is included on every page through its inclusion in `pages/_app.js`.\nFeel free to change it.\n\n### Hack Club fonts\n\nIf you’re making a Hack Club HQ project, you’re allowed to use Hack Club’s font,\n[Phantom Sans](https://www.futurefonts.xyz/phantom-foundry/phantom-sans).\nTo load it, simply uncomment the `import '@hackclub/theme/fonts/reg-bold.css'`\nline in `_app.js`.\n\n### Custom theme\n\nBy default, the raw [Hack Club Theme](https://theme.hackclub.com) will be used.\nIf you’d like to edit the theme, we recommend making a theme file (perhaps at\n`lib/theme.js`) along these lines:\n\n```js\nimport base from '@hackclub/theme'\n\nconst theme = base\n\n// theme.fontSizes = […]\n// theme.fonts.heading = ''\n\nexport default theme\n```\n\n### Running at another port\n\nSuper easy: `yarn dev -p 5000`\n\n### Adding meta tags\n\nThese template includes [@hackclub/meta](https://github.com/hackclub/theme/tree/main/packages/meta)\nfor adding meta tags to Hack Club HQ sites. To set default meta tags across all pages,\nadd the following to `pages/_app.js`:\n\n```js\n// import Head from 'next/head'\n// import Meta from '@hackclub/meta'\n\n\u003cMeta\n  as={Head}\n  name=\"Hack Club\" // site name\n  title=\"Hackathons\" // page title\n  description=\"List of upcoming high school hackathons\" // page description\n  image=\"https://hackathons.hackclub.com/card.png\" // large summary card image URL\n  color=\"#ec3750\" // theme color\n  manifest=\"/site.webmanifest\" // link to site manifest\n/\u003e\n```\n\nIf you’re not making a site for HQ, don’t use `@hackclub/meta`, since it adds\nHack Club’s favicons \u0026 info. Instead, we recommend making your own component,\nperhaps at `components/meta.js`.\n\n\u003cdetails\u003e\n\n\u003csummary\u003eExample code\u003c/summary\u003e\n\n```js\nimport Head from 'next/head'\nimport theme from '@hackclub/theme' // or '../lib/theme'\n\nexport default ({\n  name = 'Your Company',\n  title = 'Your Project',\n  description = '',\n  image = 'https://yourproject.vercel.app/card.png',\n  url = 'https://yourproject.vercel.app/'\n}) =\u003e (\n  \u003cHead\u003e\n    \u003ctitle\u003e{title}\u003c/title\u003e\n    \u003cmeta property=\"og:title\" content={title} /\u003e\n    \u003cmeta name=\"twitter:title\" content={title} /\u003e\n    \u003cmeta name=\"og:url\" content={url} /\u003e\n    \u003cmeta property=\"og:type\" content=\"website\" /\u003e\n    \u003cmeta property=\"og:site_name\" content={name} /\u003e\n    \u003cmeta name=\"description\" content={description} /\u003e\n    \u003cmeta property=\"og:description\" content={description} /\u003e\n    \u003cmeta name=\"twitter:description\" content={description} /\u003e\n    \u003cmeta property=\"og:image\" content={image} /\u003e\n    \u003cmeta name=\"twitter:card\" content=\"summary_large_image\" /\u003e\n    \u003cmeta name=\"twitter:image\" content={image} /\u003e\n    \u003cmeta name=\"msapplication-TileColor\" content={theme.colors.primary} /\u003e\n    \u003cmeta name=\"theme-color\" content={theme.colors.primary} /\u003e\n  \u003c/Head\u003e\n)\n```\n\n\u003c/details\u003e\n\n### Adding analytics\n\nHack Club HQ uses (\u0026 loves) [Fathom Analytics](https://usefathom.com/ref/NXBJA2)\nfor simple, privacy-focused analytics. ([Check out our site’s analytics here.](https://app.usefathom.com/share/ogimjefa/hackclub.com))\n\nTo add Fathom to your project, `yarn add fathom-client`, then you’ll need to\nload it appropriately in `pages/_app.js`. The script is located at\n\u003chttps://aardvark.hackclub.com/script.js\u003e.\n\n\u003cdetails\u003e\n\n\u003csummary\u003eExample file with Fathom\u003c/summary\u003e\n\n```js\nimport React, { useEffect } from 'react'\nimport { useRouter } from 'next/router'\nimport NextApp from 'next/app'\nimport Head from 'next/head'\n\nimport Meta from '@hackclub/meta'\nimport '@hackclub/theme/fonts/reg-bold.css'\nimport theme from '../lib/theme'\nimport { ThemeProvider } from 'theme-ui'\nimport * as Fathom from 'fathom-client'\n\nconst App = ({ Component, pageProps }) =\u003e {\n  const router = useRouter()\n\n  useEffect(() =\u003e {\n    Fathom.load('YOURCODE', {\n      includedDomains: ['hackclub.com'],\n      url: 'https://aardvark.hackclub.com/script.js'\n    })\n    const onRouteChangeComplete = () =\u003e Fathom.trackPageview()\n    router.events.on('routeChangeComplete', onRouteChangeComplete)\n    return () =\u003e {\n      router.events.off('routeChangeComplete', onRouteChangeComplete)\n    }\n  }, [])\n\n  return (\n    \u003cThemeProvider theme={theme}\u003e\n      \u003cMeta as={Head} /\u003e\n      \u003cComponent {...pageProps} /\u003e\n    \u003c/ThemeProvider\u003e\n  )\n}\n\nexport default App\n```\n\n\u003c/details\u003e\n\n## Deployment\n\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/git?s=https%3A%2F%2Fgithub.com%2Fhackclub%2Ftheme-starter\u0026repo-name=theme-project)\n\nWe recommend using [Vercel](https://vercel.com) for deployment. It requires no\nconfiguration, is totally free for personal projects, and supports all the features\nof Next.js with the best performance. Refer to [their documentation](https://vercel.com/docs#deploy-an-existing-project)\nfor more details.\n\nYou can also deploy your site to [Netlify](https://netlify.com), which is also free. Refer to [their documentation](https://docs.netlify.com/configure-builds/common-configurations/#next-js) on the necessary configuration.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackclub%2Ftheme-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhackclub%2Ftheme-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackclub%2Ftheme-starter/lists"}