Quick Start
+ ++
This library automates the view your GitHub projects on your website in one place. But how? Make the code configuration only once in your application with github-automated-repos, and manage the view of your projects on GitHub in the Topics field.
+
+
+ Why use?
++
-
+
- Control the visualization of your projects in one place. +
- You won't need to access code to add your projects. +
- More: customize your cards with icons. +
+
+
+ {packageInstall_NPM}
+ ) : (
+ {packageInstall_Yarn}
+ )}
+
+
+ Install Package
+ +
+
+
+
+ {changeInstallPackage === 'npm' ? (
+
+
+
+ {importPackage}
+
+ Import Package
+
+
+
+
+ The package imports four elements:
+
+ <ProjectIcon/> component that renders the icons of the projects that come from data returned from the dataGithubRepos function as the Topics property. Check the Project Icons tab!
+
+
+ <StackIcon/> component that renders the icons of the stacks that come from data returned from the dataGithubRepos function as the Topics property. Check the Stack Icons tab! +
+
+ IGithubRepos interface for the application in Typescript. Used to type the useState that will receive the array. +
+
+ useGithubAutomatedRepos ( ) hook responsible for automating the repositories. It returns a function called dataGithubRepos, which takes two parameters: data (data that comes from the GitHub API) and the keyword (the latter responsible for showing the project on your website from the moment it is declared in the Topics field of the your Github repository). The dataGithubRepos returns, so optimized, an array of objects containing 6 properties: id, html_url, homepage, topics, name and description. + +{dataReposGithubCode}
+
+
+
+ +
+ <StackIcon/> component that renders the icons of the stacks that come from data returned from the dataGithubRepos function as the Topics property. Check the Stack Icons tab! +
+
+ IGithubRepos interface for the application in Typescript. Used to type the useState that will receive the array. +
+
+ useGithubAutomatedRepos ( ) hook responsible for automating the repositories. It returns a function called dataGithubRepos, which takes two parameters: data (data that comes from the GitHub API) and the keyword (the latter responsible for showing the project on your website from the moment it is declared in the Topics field of the your Github repository). The dataGithubRepos returns, so optimized, an array of objects containing 6 properties: id, html_url, homepage, topics, name and description. + +
+
+
+
+ Fill in the fields
+
+
+ id: repository identification number. used as parameter in the key tag. This field does not need to be filled in.
+
+
+ html_url repository link. Used as the link of access. This field does not need to be filled in. +
+
+ homepage: it's the access link to the built page, page deploy. About / Website of your GitHub. +
+
+
+
+
+ topics: array that brings information about the icons in Project and Stack. Used in both ProjectIcon and StackIcon components. It is in this field that is passed the key configured in the hook. Refers to the field About / Topics of your GitHub. +
+
+
+
+
+ name: This is the name of the repository. Refers to the field Settings / General / Repository name of your GitHub. +
+
+
+
+
+ description: This is the description given to your repository. Refers to the About /Description field of your GitHub. +
+
+
+
+
+
+ +
+ html_url repository link. Used as the link of access. This field does not need to be filled in. +
+
+ homepage: it's the access link to the built page, page deploy. About / Website of your GitHub. +
+
+
+
+ topics: array that brings information about the icons in Project and Stack. Used in both ProjectIcon and StackIcon components. It is in this field that is passed the key configured in the hook. Refers to the field About / Topics of your GitHub. +
+
+
+
+ name: This is the name of the repository. Refers to the field Settings / General / Repository name of your GitHub. +
+
+
+
+ description: This is the description given to your repository. Refers to the About /Description field of your GitHub. +
+
+
+
+ {githubUsername}
+
+{keywordCode}
+
+{codeExampleJSX}
+ ) : (
+ {codeExampleTSX}
+ )}
+
+
+
+ Code Example
++ Don't forget to fill the keyword fields (determined by you) and the your github username. +
++
+
+
+
+
+
+ {changeCodeExample === 'javascript' ? (
+ 
+ 
+ 
+ 
+