Skip to content

Automated GitHub Organization Members Listing šŸš€ - Displays a dynamic list of all organization members, including private profiles, and keeps it updated with GitHub Actions and GitHub Pages.

License

Notifications You must be signed in to change notification settings

Artificial-Universe/team-organization-page

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Ā 

History

48 Commits
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 
Ā 

Repository files navigation

šŸš€ Team Organization Page

šŸ‘‹ Bem-vindo ao repositĆ³rio oficial da pĆ”gina de listagem de membros da organizaĆ§Ć£o Artificial-Universe! Este projeto tem como objetivo criar uma interface dinĆ¢mica e automatizada que exibe todos os membros da organizaĆ§Ć£o, incluindo aqueles com perfis privados, garantindo que a pĆ”gina seja atualizada automaticamente sempre que um novo membro for adicionado.

šŸŒŸ Funcionalidade

Este repositĆ³rio foi desenvolvido para fornecer uma visualizaĆ§Ć£o pĆŗblica de todos os membros da organizaĆ§Ć£o Artificial-Universe. Aqui estĆ£o algumas das principais funcionalidades do projeto:

  • šŸ”„ AtualizaĆ§Ć£o AutomĆ”tica: A pĆ”gina de membros Ć© atualizada diariamente Ć  meia-noite (UTC) usando GitHub Actions. Sempre que um novo membro ingressa na organizaĆ§Ć£o, a listagem serĆ” atualizada automaticamente.
  • šŸ‘¤ Suporte para Membros PĆŗblicos e Privados: Todos os membros sĆ£o exibidos, independentemente do status de visibilidade dos seus perfis.
  • šŸ“œ Interface Simples e Intuitiva: A pĆ”gina oferece uma tabela limpa e bem organizada com os nomes e as Ć”reas de atuaĆ§Ć£o (que podem ser definidas no futuro) de cada membro.

šŸŽÆ Objetivo

O objetivo deste repositĆ³rio Ć© facilitar o acompanhamento e visualizaĆ§Ć£o dos membros da organizaĆ§Ć£o, com atualizaƧƵes automĆ”ticas para garantir que sempre exibamos os membros mais recentes. Este projeto faz parte de uma integraĆ§Ć£o maior com o GitHub Projects da organizaĆ§Ć£o Artificial-Universe, sendo uma interface que pode ser usada para exibir a lista de participantes em outros mĆ³dulos do projeto.

šŸ§© IntegraĆ§Ć£o com o GitHub Projects

Este repositĆ³rio serĆ” integrado ao GitHub Projects como parte do gerenciamento de membros e seus papĆ©is dentro do projeto. A interface servirĆ” como um recurso de monitoramento, permitindo que os administradores e colaboradores acompanhem quem estĆ” envolvido nas diferentes atividades da organizaĆ§Ć£o.

  • Os dados dos membros serĆ£o automaticamente atualizados e poderĆ£o ser usados em outras Ć”reas do GitHub Projects, como tarefas atribuĆ­das, progressos, e discussƵes.
  • Futuramente, serĆ” possĆ­vel associar os membros a seus respectivos papĆ©is em projetos especĆ­ficos da organizaĆ§Ć£o, ajudando a organizar melhor as equipes de desenvolvimento.

šŸ›  Tecnologias Utilizadas

Este projeto foi desenvolvido utilizando as seguintes tecnologias:

  • Node.js: Utilizado para criar scripts automatizados que acessam a API do GitHub e geram a listagem de membros.
  • GitHub API: A API do GitHub Ć© utilizada para buscar os membros da organizaĆ§Ć£o e suas informaƧƵes.
  • GitHub Actions: AutomaĆ§Ć£o que executa diariamente a atualizaĆ§Ć£o dos membros da organizaĆ§Ć£o e gera o arquivo team-members.json usado na pĆ”gina.
  • HTML/CSS: A interface Ć© construĆ­da usando uma pĆ”gina HTML simples, estilizada com CSS para exibir os membros em uma tabela limpa e organizada.
  • JSON: Os dados dos membros sĆ£o salvos em um arquivo team-members.json, que alimenta a interface.

šŸ›  Como Funciona

  1. AtualizaĆ§Ć£o DiĆ”ria: AtravĆ©s de um workflow do GitHub Actions, o script script.js Ć© executado todos os dias Ć  meia-noite (UTC), fazendo uma chamada Ć  API do GitHub para buscar os membros da organizaĆ§Ć£o.
  2. Listagem dos Membros: Todos os membros da organizaĆ§Ć£o sĆ£o coletados, incluindo aqueles com perfis privados, e sĆ£o salvos no arquivo team-members.json.
  3. ExibiĆ§Ć£o na PĆ”gina: A pĆ”gina HTML consome os dados do arquivo team-members.json e exibe os membros em uma tabela na pĆ”gina web.

šŸš€ Para Executar Localmente

Se vocĆŖ deseja rodar este projeto localmente, siga as instruƧƵes abaixo:

  1. Clone o RepositĆ³rio:

    git clone https://github.com/Artificial-Universe/team-organization-page.git
    cd team-organization-page
  2. Instale as DependĆŖncias: Certifique-se de que vocĆŖ tem o Node.js instalado. EntĆ£o, rode:

    npm install
  3. Defina o Token do GitHub: Crie um arquivo .env na raiz do projeto e adicione seu GITHUB_TOKEN:

    GITHUB_TOKEN=your_github_token
  4. Execute o Script: Para listar manualmente os membros da organizaĆ§Ć£o:

    npm start
  5. Visualize a PƔgina: Abra o arquivo index.html no seu navegador favorito para visualizar a tabela de membros.

šŸ”„ AutomatizaĆ§Ć£o com GitHub Actions

  • Este projeto utiliza o GitHub Actions para automaĆ§Ć£o da coleta de dados. A cada novo membro adicionado Ć  organizaĆ§Ć£o, o workflow abaixo serĆ” acionado para atualizar a lista de membros:

    name: List Organization Members
on:
  workflow_dispatch:
  schedule:
    - cron: '0 0 * * *' # Executa o workflow todos os dias Ć  meia-noite UTC

jobs:
  list-members:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Setup Node.js
        uses: actions/setup-node@v2
        with:
          node-version: '14'

      - name: Install dependencies
        run: npm install

      - name: List Members
        run: |
          node script.js
        env:
          GITHUB_TOKEN: ${{ secrets.TOKEN_GITHUB }}

šŸ“š ContribuiƧƵes

Estamos sempre abertos a novas ideias e contribuiƧƵes! Se vocĆŖ deseja sugerir melhorias ou adicionar novas funcionalidades, fique Ć  vontade para abrir uma issue ou enviar um pull request.

Como Contribuir

  1. FaƧa um Fork do projeto.

  2. Crie uma nova branch com sua funcionalidade ou correĆ§Ć£o:

git checkout -b minha-nova-feature
  1. Commit suas alteraƧƵes:
git commit -m 'Adicionando minha nova feature'
  1. Push para a branch:
git push origin minha-nova-feature
  1. Abra um Pull Request.

šŸŽ‰ Agradecimentos

Agradecemos a todos os membros da organizaĆ§Ć£o Artificial-Universe que estĆ£o contribuindo ativamente para o desenvolvimento deste projeto. Vamos continuar evoluindo juntos! šŸ’ŖšŸŒŒ

About

Automated GitHub Organization Members Listing šŸš€ - Displays a dynamic list of all organization members, including private profiles, and keeps it updated with GitHub Actions and GitHub Pages.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published