github-automated-repos
Version:
A powerful React library that automatically displays and updates your GitHub repositories on your portfolio or personal website. Use simple React hooks to sync your GitHub projects and keep your developer portfolio always up to date.
768 lines (467 loc) • 41.4 kB
Markdown
<!--Commit changes
-->
<!-- VISUALIZAR NO VSCODE CTRL + K V -->
<!-- BADGES https://www.youtube.com/watch?v=cRoBt6AZgjc
https://dev.to/envoy_/150-badges-for-github-pnk
BUILD BADGES
https://shields.io
ICONS
https://simpleicons.org/?q=react
EXEMPLO
<a href="https://devdigoarthur.notion.site/Map-a87c73417a064372b122bf448f4c6ed4"> <a/>
# JavaScript - Nome que aparece na Bag
# logo=JavaScript - Muda a logo vide <https://simpleicons.org/?q=react>
# color
=yellow - Define a cor da bag vide <https://shields.io>
# logoColor=white - Define a cor do icone
https://user-images.githubusercontent.com/59892368/219479919-5e84de50-6b7d-4d42-bb6d-a466b450db84.svg
-->
<!------------------------------------ -------------------->
<!------------------------------------ LANGUAGE BUTTONS-->
<!------------------------------------ -------------------->
<p align="right">
<a href="https://github.com/DIGOARTHUR/github-automated-repos#readme">
<img height="22" src="https://github-production-user-asset-6210df.s3.amazonaws.com/59892368/257623321-95c81f57-b751-4956-b0ab-7a804ae44506.svg" alt="English" border="0">
<a/>
<a href="https://github.com/DIGOARTHUR/github-automated-repos/blob/main/README_PT.md">
<img alt="Português" height="22" src="https://github-production-user-asset-6210df.s3.amazonaws.com/59892368/288551794-f50cff19-7ef7-41c4-81b5-b091ebd0f498.svg">
<a/>
</p>
<!------------------------------------ -------------------->
<!------------------------------------ PROJECT BANNER-->
<!------------------------------------ -------------------->
<img alt="banner_logo_github-automated-repos" src="https://github.com/user-attachments/assets/f0fbbf5a-fb96-49ec-8be4-c7b9e7b0b17b">
<br>
<br>
<!------------------------------------ -------------------->
<!------------------------------------SHIELDS PROJECT-->
<!------------------------------------ -------------------->
<div align="center">
[]( )
</div>
<!------------------------------------ ---------------------------->
<!------------------------------------ PROJECT SHORT DESCRIPTION-->
<!------------------------------------ --------------------------->
<p align="center">
<br>
✅ github-automated-repos is the library,<code>ReactJS</code>, that gives you the power to control your GitHub data, your projects on the portfolio / website,
in your own GitHub in one place!</i>
<br>
<br>
❌ project.js files ( edit code )
❌ GitHub API ( no data control )
</p>
<p align="center">
<img alt="github-automated-repos library" src="https://github.com/user-attachments/assets/78ac832b-9e01-4fc2-9bdd-32b533e2ed83">
</p>
<!---
• Install lib `github-automated-repos` ➥
<br>
• Configure the useGitHubAutomatedRepos hook with your GitHubUsername and KeyWord
<br>
• Ready! Now all projects can be managed on their own `GitHub`, in the `Topics field`.
-->
<!------------------------------------ -------------------->
<!------------------------------------LINKS-->
<!------------------------------------ -------------------->
<p align="center">
<a href="https://github-automated-repos.vercel.app"><strong>https://github-automated-repos.vercel.app</strong></a>
<br>
</p>
<p align="center">
<a href="CONTRIBUTING.md">Contributing Guidelines</a>
<br>
<br>
</p>
<br>
<br>
<!------------------------------------ -------------------->
<!------------------------------------SUMMARY-->
<!------------------------------------ -------------------->
<p align="center" alt="github-automated-repos summary">
<a href="https://github.com/digoarthur/github-automated-repos?tab=readme-ov-file#init---cli">
<img src="https://github.com/user-attachments/assets/d257063a-cc08-4b34-abac-a8babc84f2a5" alt="init - CLI" border="0">
<a/>
<a href="https://github.com/digoarthur/github-automated-repos?tab=readme-ov-file#--stack-icons">
<img src="https://github.com/user-attachments/assets/c0dd0201-8bf7-4c98-9c32-5beec64b2391" alt="Stack Icons" border="0">
<a/>
<a href="https://github.com/digoarthur/github-automated-repos?tab=readme-ov-file#--hook--components">
<img src="https://github.com/user-attachments/assets/d0abe7af-f6ca-4d41-b881-f49af94b051a" alt="Hook & Components" border="0">
<a/>
<a href="https://github.com/digoarthur/github-automated-repos?tab=readme-ov-file#-fill-in-the-fields-in-the-github-repository">
<img src="https://github.com/user-attachments/assets/1d66d03c-8b53-4752-a6a8-6c23672b82871" alt="Fill the fields of the repository (GitHub)" border="0">
<a/>
<a href="https://github.com/digoarthur/github-automated-repos?tab=readme-ov-file#-react-query-config">
<img src="https://github.com/user-attachments/assets/45292a01-343a-422c-8500-2616ac5a2af3" alt="React Query Config." border="0">
<a/>
</p>
<!-------------------------------------------------- -->
<!------------------------------------------ DESCRIPTION-->
<!-------------------------------------------------- -->
# <img alt="skills" width="40" height="40" src="https://user-images.githubusercontent.com/59892368/148622497-164365e8-f6b0-4f40-bc75-a0ed4da6059b.png"> About Library <!---write here : talk a little about project: what's does, example. -->
> This library automates the view your GitHub projects on your porfolio / 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. Choose which project will be seen, and you can even customize your project card, for example, with a representative icon and show which stacks were used. All in one place!
<details>
<summary> Details </summary>
| Control your projects |
| :-------------------------------------------------------------------: |
|  |
| Customize and represent through icons. |
| :--------------------------------------------------------------: |
| |
| In one place |
| :-------------------------------------------------------------------: |
| |
</details>
<br/>
<br/>
<!------------------------------------ -------------------->
<!------------------------------------GETTING START-->
<!------------------------------------ -------------------->
----
# init - CLI
## 1. Run Command
```yaml
npx github-automated-repos-cli init
```
<div align="center">
</div>
## 2. Enter data
#### 🦑 GitHub Username
You will be prompted to enter your GitHub username.
> This is used to fetch your public repositories directly from GitHub.
```yaml
✔ GitHub username: xxxxxx
```
#### 🔑 Keyword (Repository Filter)
Next, you’ll choose a keyword (for example: <code> attached </code>, <code>portfolio </code>, <code>featured </code>).
> This keyword will be used to filter repositories via the GitHub Topics field.
```yaml
✔ Keyword to filter (e.g. 'attached'): attached
```
> [!IMPORTANT]
> Don't forget to enter your Keyword in the Topics field of each project so it appears on the generated page.
<div align="center">
</div>
## 3. Terminal Result
```yaml
√ Target file already exists:
C:\Users\Leveling IT\Desktop\Person-Page\testenext\app\projects\page.tsx
What would you like to do? » Overwrite
✔ GitHub username: digoarthur
✔ Keyword to filter (e.g. 'attached'): attached
✔ Template ready.
✔ File created at: C:\Users\Leveling IT\Desktop\Person-Page\testenext\app\projects\page.tsx
✨ Your project page is ready!
🔗 http://localhost:3000/projects
Init finished successfully.
```
<div align="center">
</div>
## 4. Banner
> Insert banner, layout images to represent your project. Types are `.PNG` and `.SVG`. For this to be possible, the name of the image file must contain `banner`in the name. Insert your images in the following path: Ex.:
```
└── public
└── `bannerXYZ.png`
└── `bannerABC.svg`
├── ...
```
<div align="center">
<img alt="dashgo_layout" height="150" src="https://github.com/DIGOARTHUR/github-automated-repos/assets/59892368/68f59bce-0d8f-4cea-81c9-01596d97f47e">
<img alt="dashfincaneiro_layout" height="150" src="https://github.com/DIGOARTHUR/github-automated-repos/assets/59892368/86dac1db-d04a-462b-a2ea-f00db264dbad">
<img alt="proffy_layout" height="150" src="https://github.com/DIGOARTHUR/github-automated-repos/assets/59892368/bfcd0785-ce8a-4327-8b8b-5de495528c3f">
</div>
<div align="center">
</div>
## 5. Choose the repositories and fill in the Topics field with the keyword you determined.
> [!IMPORTANT]
> To insert stack names in the topics field, see web documentation or the table below. > [Stack Icons](https://github.com/digoarthur/github-automated-repos?tab=readme-ov-file#--stack-icons)
<div align="center" alt='stackIcons List'>
</div>
<div align="center">
</div>
## 6. ✅Ready! JSON - Data from repositories chosen by you!
> [!TIP]
> Customize your cards your way
<details>
<summary>JSON - DATA</summary>
### Data Example ~ console.log(data) ~
```javascript
Array(4)
0
:
{id: 517152367, name: 'Dashgo', html_url: 'https://github.com/DIGOARTHUR/Dashgo', description: 'IGNITE - Trilha ReactJS/ - Neste projeto é aplicad…ate, Components, Props. Recursos do JS como: Map.', topics: Array(7), …}
1
:
{id: 482667387, name: 'DashBoard-Financeiro', html_url: 'https://github.com/DIGOARTHUR/DashBoard-Financeiro', description: 'IGNITE - Trilha ReactJS/ Chapter II - Esta aplicaç…mpanhamento de valores de entrada, saída e total.', topics: Array(6), …}
2
:
{id: 412849316, name: 'Task.TODO', html_url: 'https://github.com/DIGOARTHUR/Task.TODO', description: 'IGNITE - Trilha ReactJS/ - Este projeto aborda con…Filter e Math, Spread. E para estilização o SASS.', topics: Array(7), …}
3
:
{id: 355616217, name: 'Move.it', html_url: 'https://github.com/DIGOARTHUR/Move.it', description: 'NLW#04 - Rocketseat - Utilizando a técnica Pomodor… o objetivo é executar a tarefa do seu interesse.', topics: Array(8), …}
length
:
4
[[Prototype]]
:
Array(0)
```
</details>
<details>
<summary>IN PAGE WEB</summary>
> [!TIP]
> Customize your cards your way!
</details>
</br>
---
</br>
<!----------------------------------------------------------->
<!--------------------------- STACK ICONS TABLE ------------->
<!--------------------------------------------------------- -->
# <img width="50" height="50" alt="hook-svgrepo-com" src="https://github.com/user-attachments/assets/e91139f9-e37e-43d8-9fea-0283ef9537c5" /> Stack Icons
> Stack icons for you to customize your cards; insert the labels in the Topics field of your repository.
<details>
<br/>
<br/>
<div align='center'>
| Logo | Stack Name | Logo | Stack Name | Logo | Stack Name | Logo | Stack Name |
| :---: | --- | :---: | --- | :---: | --- | :---: | --- |
|  | `androidstudio` |  | `angular` |  | `arduino` |  | `aws` |
|  | `babel` |  | `bash` |  | `bitbucket` |  | `blender` |
|  | `bootstrap` |  | `c` |  | `canva` |  | `clion` |
|  | `cpp` |  | `csharp` |  | `css3` |  | `dart` |
|  | `denojs` |  | `django` |  | `docker` |  | `dotnetcore` |
|  | `eclipse` |  | `elixir` |  | `eslint` |  | `expo` |
|  | `express` |  | `figma` |  | `firebase` |  | `flask` |
|  | `flutter` |  | `gatsby` |  | `gimp` |  | `git` |
|  | `go` |  | `googlecloud` |  | `graphql` |  | `grunt` |
|  | `gulpjs` |  | `haskell` |  | `heroku` |  | `html5` |
|  | `husky` |  | `inkscape` |  | `java` |  | `javascript` |
|  | `jenkins` |  | `jest` |  | `jira` |  | `jquery` |
|  | `jupyter` |  | `kotlin` |  | `kubernetes` |  | `laravel` |
|  | `linux` |  | `lua` |  | `markdown` |  | `materialui` |
|  | `mongodb` |  | `mysql` |  | `nestjs` |  | `netcore` |
|  | `nextjs` |  | `nodejs` |  | `npm` |  | `objectc` |
|  | `pearl` |  | `php` |  | `postgresql` |  | `prettier` |
|  | `prisma` |  | `pycharm` |  | `python` |  | `r` |
|  | `rails` |  | `raspberrypi` |  | `react` |  | `reacticons` |
|  | `redux` |  | `ruby` |  | `rust` |  | `salesforce` |
|  | `sass` |  | `scala` |  | `sequelize` |  | `spring` |
|  | `sqlite` |  | `storybook` |  | `styledcomponents` |  | `swagger` |
|  | `switch` |  | `tailwind` |  | `typescript` |  | `visualstudio` |
|  | `visualstudiocode` |  | `vitejs` |  | `vuejs` |  | `yarn` |
</div>
</details>
</br>
</br>
</br>
<!----------------------------------------------------------->
<!--------------------------- HOOK & COMPONENTS ------------->
<!--------------------------------------------------------- -->
# <img width="50" height="50" alt="hook-svgrepo-com" src="https://github.com/user-attachments/assets/9d0e91e7-d6f4-4a99-aed7-2aa8211d6e8f" /> <img width="50" height="50" alt="abstract" src="https://github.com/user-attachments/assets/228dc2cb-8aad-4d79-9d9a-71bd39e201af" /> Hook & Components
> Learn more about the Hook and Components that render the Stack icons.
<details>
</p>
<br>
- `useGitHubAutomatedRepos` hook responsible for automating the return of data from repositories. This hook takes two parameters: GitHubUsername & keyword. The return is an array of objects containing 7 properties: id, banner, html_url, homepage, topics, name and description.
```tsx
const { data, isLoading, isLoadingError } = useGitHubAutomatedRepos("GitHubUsername", "KeyWord");
```
- #### return data example:
``` javascript
[
{
banner:"https://raw.githubusercontent.com/DIGOARTHUR/github-automated-repos/main/src/assets/images/banner.png"
description: "The library that automates, in one place, the administration of your github projects on your website."
homepage: "https://github-automated-repos.vercel.app"
html_url: "https://github.com/DIGOARTHUR/github-automated-repos"
id: 585693873
name: "github-automated-repos"
topics: (8) ['automated', 'deploy', 'github', 'library', '
}
]
```
- #### isLoading: while the data is not loaded, isLoading returns TRUE.
```jsx
if (isLoading) {
return <div> loading...</div>
}
```
- #### isLoadingError: will be true if the query failed while fetching for the first time.
<br>
- `StackIcons` The component returns, based on the iteration of the topic array that is contained in data, icons of the stacks used in your project. Enter the stacks used in your repository's topic field.. Check the [Stack Icons](https://github-automated-repos.vercel.app/documentation/stackIcons) tab!
```jsx
data?.map((item) => {
return (
...
{item.topics.map((icon, index) => {
return (
<StackIcons key={index} itemTopics={ icon } className={ } />
}
...
```
- #### Render component StackIcons example:
<div align="center">
</div>
<br>
<br>
- `StackLabels` component returns, based on the iteration of the topics array that is contained in data, labels of the stacks used in your project. Insert the stacks used in the topics field of your repository. Check the [Stack Icons](https://github-automated-repos.vercel.app/documentation/stackIcons) tab!
```jsx
data.map((item) => {
return (
...
{item.topics.map((icon, index) => {
return (
<StackLabels key={ index } itemTopics={ icon } className={ } />
}
...
```
- #### Render component StackLabels example:
<div align="center">
     
</div>
<br>
<br>
</div>
</details>
</br>
</br>
</br>
<!------------------------------------ -------------------->
<!------------------------------------ FILL IN THE FIELDS -->
<!------------------------------------ -------------------->
# <img alt="skills" width="40" height="40" src="https://github.com/user-attachments/assets/403167b1-57eb-4ee9-818d-a591c6885f91"> Fill in the fields in the github repository
> [!IMPORTANT]
> Pay attention to filling in each field of your repository on GitHub.
<details>
<br/>
- `banner`: this property returns a .PNG e .SVG image. For this to be possible, the name of the image file must contain `banner`in the name. Insert your images in the following path: Ex.:
```
└── public
└── `bannerXYZ.png`
└── `bannerABC.svg`
├── ...
```
<div align="center">
<img alt="dashgo_layout" height="150" src="https://github.com/DIGOARTHUR/github-automated-repos/assets/59892368/68f59bce-0d8f-4cea-81c9-01596d97f47e">
<img alt="dashfincaneiro_layout" height="150" src="https://github.com/DIGOARTHUR/github-automated-repos/assets/59892368/86dac1db-d04a-462b-a2ea-f00db264dbad">
<img alt="proffy_layout" height="150" src="https://github.com/DIGOARTHUR/github-automated-repos/assets/59892368/bfcd0785-ce8a-4327-8b8b-5de495528c3f">
</div>
- `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.
<div align="center">
<img alt="homepage_Props" src="https://user-images.githubusercontent.com/59892368/219116735-a026d9b9-f5b9-4389-b8f1-619db2488368.png">
</div>
<br>
- `topics`: array that brings information about the icons in [Stack Icons](https://github-automated-repos.vercel.app/stackicons). Used in both StackLabels e 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.
<div align="center">
<img alt="topics_Props" src="https://github.com/user-attachments/assets/00b55402-c64b-49c4-982f-8b90a6c12ce8">
</div>
<br>
- `name`: this is the name of the repository. Refers to the field Settings / General / Repository name of your GitHub.
<div align="center">
<img alt="name_Props" src="https://user-images.githubusercontent.com/59892368/219117097-43db2497-7f62-428e-85c6-ef3656da4cd2.png">
</div>
<br>
- `description`: this is the description given to your repository. Refers to the About /Description field of your GitHub.
<div align="center">
<img alt="description_Props" src="https://user-images.githubusercontent.com/59892368/219117260-5bdb1fbb-c58b-4ad9-938a-068b58c72f27.png">
</div>
</details>
</br>
</br>
</br>
<!----------------------------------------------------------->
<!--------------------------- REACT QUERY ------------->
<!--------------------------------------------------------- -->
# <img alt="NextJS" width="50" height="50" src="https://github.com/DIGOARTHUR/github-automated-repos/assets/59892368/eb3732e9-d3a9-4f9f-b706-8969557681aa"> React Query Config.
> [!NOTE]
> Follow the official standard React Query installation instructions.
```tsx
import { useGitHubAutomatedRepos, StackIcons, StackLabels } from "github-automated-repos/react-query";
```
#### Hook Example:
```tsx
// Usage Example + [ React Query ]
const { data, isLoading } = useGitHubAutomatedRepos('digoarthur', 'attached', {
refetchInterval: 300000, // 5 minutes
refetchOnWindowFocus: false,
staleTime: 10 * 60 * 1000, // 10 minutes
});
```
<br>
<br>
---
<br>
<br>
**Love github-automated-repos? Give our repo a star ⭐ [⬆️](https://github.com/DIGOARTHUR/github-automated-repos) .**
`based in:` [Api Github](https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#get-a-repository)
`by`: [@digoarthur](https://www.linkedin.com/in/digoarthur/) <a href="https://youtu.be/dQw4w9WgXcQ?si=VBzREBlncKuPTYBs"> <img src="https://github.com/user-attachments/assets/f45f0115-761e-4207-a9d9-dddacfb5b96b" alt="Brazil Flag" width="20" /> </a>
<div align="center">
**[github-automated-repos-cli](https://github.com/digoarthur/github-automated-repos-cli)**
</div>