{"id":25011385,"url":"https://github.com/aabuhijleh/better-github-profile","last_synced_at":"2025-07-22T17:35:10.945Z","repository":{"id":106015587,"uuid":"319966526","full_name":"aabuhijleh/better-github-profile","owner":"aabuhijleh","description":"Use your GitHub profile to create a personal website","archived":false,"fork":false,"pushed_at":"2024-09-18T22:48:39.000Z","size":4349,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-12T20:12:09.817Z","etag":null,"topics":["github","graphql","profile","react","readme","styled-components"],"latest_commit_sha":null,"homepage":"https://github.aabuhijleh.com","language":"TypeScript","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/aabuhijleh.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}},"created_at":"2020-12-09T13:34:20.000Z","updated_at":"2024-11-18T20:23:30.000Z","dependencies_parsed_at":"2025-02-06T10:30:59.135Z","dependency_job_id":null,"html_url":"https://github.com/aabuhijleh/better-github-profile","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/aabuhijleh/better-github-profile","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aabuhijleh%2Fbetter-github-profile","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aabuhijleh%2Fbetter-github-profile/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aabuhijleh%2Fbetter-github-profile/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aabuhijleh%2Fbetter-github-profile/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aabuhijleh","download_url":"https://codeload.github.com/aabuhijleh/better-github-profile/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aabuhijleh%2Fbetter-github-profile/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266540247,"owners_count":23945186,"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","status":"online","status_checked_at":"2025-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"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":["github","graphql","profile","react","readme","styled-components"],"created_at":"2025-02-05T05:31:13.329Z","updated_at":"2025-07-22T17:35:10.918Z","avatar_url":"https://github.com/aabuhijleh.png","language":"TypeScript","readme":"# 🚀 Better GitHub Profile\n\n\u003e Use your GitHub profile to create a personal website\n\n[Demo page](https://www.aabuhijleh.com/)\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://user-images.githubusercontent.com/42934634/122873598-a1bcc900-d33a-11eb-91ce-794b213363ab.png\" alt=\"example\" /\u003e\n\u003c/p\u003e\n\n## How it works? 🙋‍♀️\n\nThe content of this website is generated dynamically using the [GitHub GraphQL API](https://docs.github.com/en/graphql) which is used to download your [profile README.md](https://docs.github.com/en/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme) and your [user data](https://docs.github.com/en/graphql/reference/objects#user)\n\nAn extra file `extend.json` is required to be in your profile readme repository\n\n[See this example](https://github.com/aabuhijleh/aabuhijleh/blob/main/extend.json)\n\n```ts\n// Your \"extend.json\" file should have this schema\n\ninterface ExtendedData {\n  resume: string;\n  about: {\n    paragraphs: string[];\n    skills: string[];\n    imageUrl: string;\n  };\n  jobs: Job[];\n  featuredProjects: FeaturedProject[];\n  otherProjects: Project[];\n  contactMessage: string;\n}\n\ninterface Job {\n  title: string;\n  company: string;\n  companyUrl: string;\n  date: {\n    from: string;\n    to: string;\n  };\n  accomplishments: string[];\n}\n\ninterface Project {\n  name: string;\n  description: string;\n  technologies: string[];\n  date: {\n    from: string;\n    to: string;\n  };\n  repoUrl?: string;\n  externalUrl?: string;\n}\n\ntype FeaturedProject = Project \u0026 { imageUrl: string };\n```\n\n## Try it out 🧪\n\nBy default, the app uses the profile of the username set in `src/constants/defaults.ts`\n\nTo use a different profile, you can use this URL parameter\n\n```plaintext\n/?username={username}\n```\n\n## Development 💻\n\nThis project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app)\n\n```sh\n# install dependencies\n$ npm install\n\n# run the app in development\n$ npm start\n\n# generate GraphQL code\n$ npm run gen\n\n# build the app for production\n$ npm run build\n```\n\nYou need to generate a [GitHub key](https://docs.github.com/en/graphql/guides/forming-calls-with-graphql#authenticating-with-graphql) to use the GraphQL API. Add this key as an environment variable `REACT_APP_GITHUB_KEY` in a `.env` file that needs to be created at the project's root directory\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faabuhijleh%2Fbetter-github-profile","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faabuhijleh%2Fbetter-github-profile","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faabuhijleh%2Fbetter-github-profile/lists"}