Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/digoarthur/github-automated-repos
The library, ReactJS, that automates, in your own GitHub, the visualization of your repository/project data in your Portfolio.
https://github.com/digoarthur/github-automated-repos
attached automated github library npm opensource porfolio reactjs typescript
Last synced: 6 days ago
JSON representation
The library, ReactJS, that automates, in your own GitHub, the visualization of your repository/project data in your Portfolio.
- Host: GitHub
- URL: https://github.com/digoarthur/github-automated-repos
- Owner: DIGOARTHUR
- License: mit
- Created: 2023-01-05T20:38:36.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-24T18:43:12.000Z (28 days ago)
- Last Synced: 2024-12-25T11:00:09.877Z (27 days ago)
- Topics: attached, automated, github, library, npm, opensource, porfolio, reactjs, typescript
- Language: TypeScript
- Homepage: https://github-automated-repos.vercel.app/stackicons
- Size: 1.56 MB
- Stars: 947
- Watchers: 4
- Forks: 17
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
[]( )
✅ github-automated-repos is the library,ReactJS, that gives you the power to control your GitHub data, your projects on the portfolio / website,
in your own GitHub in one place!
❌ project.js files (keep updating code)
❌ GitHub API (no data control)
https://github-automated-repos.vercel.app
----
# Getting Start [ 6 steps ]
## 1. Installation
```shell
npm install github-automated-repos
```
```shell
yarn add github-automated-repos
```
## 2. Config. ReactQuery (ViteJS)
> [!IMPORTANT]
> Don’t forget to configure the `React Query`!!! See NextJS code example. [Code Example](https://github.com/DIGOARTHUR/github-automated-repos/tree/main?tab=readme-ov-file#code-example-1)
```tsx
import { ReactQueryProvider } from 'github-automated-repos'
createRoot(document.getElementById('root')!).render(
,
)
```
## 3. Using hook ( useGitHubAutomatedRepos() )
> [!CAUTION]
> :exclamation::exclamation: Don't forget to fill in the fields: your GitHubUsername and keyWord (chosen by you).
```typescript
import { useGitHubAutomatedRepos } from "github-automated-repos";
const { data } = useGitHubAutomatedRepos("GitHubUsername", "KeyWord");
```
## 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`
├── ...
```
## 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-automated-repos.vercel.app)
## StackIcons Table
| 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` |
## 6. ✅Ready! JSON - Data from repositories chosen by you!
> [!TIP]
> Customize your cards your way
JSON - DATA
### 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)
```
IN PAGE WEB
> [!TIP]
> Customize your cards your way!
---
# 
About Library
> 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!
| Control your projects |
| :-------------------------------------------------------------------: |
|  |
| Customize and represent through icons. |
| :--------------------------------------------------------------: |
| |
| In one place |
| :-------------------------------------------------------------------: |
| |
---
# 
Import Library
> The github-automated-repos library imports 4 resources: hook `useGitHubAutomatedRepos`, `ReactQueryProvider` , `StackIcons` component and `StackLabels` component.
```jsx
import { useGitHubAutomatedRepos, ReactQueryProvider, StackIcons, StackLabels } from 'github-automated-repos';
```
### The package imports 4 elements:
- `ReactQueryProvider` tool used to optimize the requirements of the API. Don’t forget to set it up! [Code Example](https://github.com/DIGOARTHUR/github-automated-repos/tree/main?tab=readme-ov-file#code-example-1)
- `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
loading...
}
```
- #### isLoadingError: will be true if the query failed while fetching for the first time.
- `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 (
}
...
```
- #### Render component StackIcons example:
- `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 (
}
...
```
- #### Render component StackLabels example:
     
---
# 
Fill in the fields in the github repository
> [!IMPORTANT]
> Pay attention to filling in each field of your repository on GitHub.
- `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`
├── ...
```
- `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 [Stack Icons](https://github-automated-repos.vercel.app/documentation/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.
- `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.
---
# Code Example
## 
React Query Config.
## 
ViteJS `main{.tsx/.jsx}`
```tsx
{/*------------------------------*/ }
{/*TOP OF THE CODE < main.tsx > */ }
{/*------------------------------*/ }
import { ReactQueryProvider } from 'github-automated-repos'
```
```tsx
{/*------------------------------*/ }
{/*FUNCTION < main.tsx > */ }
{/*------------------------------*/ }
createRoot(document.getElementById('root')!).render(
,
)
```
## 
NextJS `layout{.tsx/.jsx}`
> [!IMPORTANT]
> If the app does not work, type the `'use client;'` at the top of the `page.tsx` file and `layout.tsx`.
```tsx
{/*------------------------------*/ }
{/* LIBRARY IMPORT < layout.tsx > */ }
{/*------------------------------*/ }
'use client';
import { ReactQueryProvider } from "github-automated-repos";
```
```tsx
{/*------------------------------*/ }
{/*FUNCTION < layout.tsx > */ }
{/*------------------------------*/ }
const geistSans = Geist({
variable: "--font-geist-sans",
subsets: ["latin"],
});
const geistMono = Geist_Mono({
variable: "--font-geist-mono",
subsets: ["latin"],
});
export default function RootLayout({
children,
}: Readonly<{
children: React.ReactNode;
}>) {
return (
{children}
);
}
```
## `App{.tsx/.jsx}` or `Page{.tsx/.jsx}`
> [!CAUTION]
> :exclamation::exclamation: Don't forget to fill in the fields: your GitHubUsername and keyWord (determined by you).
```javascript
const data = useGitHubAutomatedRepos("GitHubUsername", "KeyWord");
```
> [!IMPORTANT]
> If the `NextJS` app does not work, type the `'use client;'` at the top of the `page.tsx` file and `layout.tsx`. .
```tsx
{/*------------------------------*/ }
{/*TOP OF THE CODE >*/ }
{/*------------------------------*/ }
//'use client';
import { StackIcons, StackLabels, useGitHubAutomatedRepos } from "github-automated-repos";
````
```tsx
{/*------------------------------*/ }
{/*INSIDE IN FUNCTION>*/ }
{/*------------------------------*/ }
{/*CSS STYLE */ }
const styleCSS: { [key: string]: React.CSSProperties } = {
div: {
display: 'flex',
alignItems: 'center',
flexDirection: 'column'
},
logo: {
width: '60rem',
},
section: {
display: 'flex',
alignItems: 'center',
flexDirection: 'column',
marginBottom: '100px',
},
name: {
fontSize: '30px',
fontFamily: 'cursive'
},
bannerDiv: {
display: 'flex',
flexDirection: 'row',
justifyContent: 'center',
gap: "2px",
},
banner: {
width: "250px"
},
componentsDiv: {
display: 'flex',
flexDirection: 'row',
justifyContent: 'center',
gap: "10px"
},
description: {
width: '700px'
},
LinksDiv: {
display: 'flex',
gap: '10px',
fontWeight: '500',
color: '#646cff',
textDecoration: 'inherit',
}
}
{/* ---------- HOOK ------ */ }
const { data, isLoading } = useGitHubAutomatedRepos("GitHubUsername", "KeyWord");
if (isLoading) {
return
loading...
}
return (
{
data?.map((item, index) => {
return (
{/*Name / Title*/}
{item.name}
{/*Banner*/}
{
item.banner.map((item, index) => {
return (
)
})
}
{/*Topics - Components StackIcons & StackLabels*/}
{item.topics.map((icon, index) => {
return (
)
})}
{/*Description*/}
{item.description}
)
})
}
);
```
---
**Love github-automated-repos? Give our repo a star ⭐ ⬆️.**
`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/)
