gh next

Um clone simples de github no próximo.js

Um simples código aberto alternativo do Github no Github (Irônico, certo?), Ele mira é estar totalmente funcional com algumas das principais características do trabalho do GitHub.

Consulte #84 para obter mais informações sobre os recursos suportados.

️ Este projeto está em desenvolvimento ativo ️

Espere que as coisas quebrem.

Roteiro

Clique para ver mais

• Login/logout
• Página inicial (conteúdo de leitura)
• Layout responsivo
• Página de configurações para alternar o tema
• Página de Stargazers
• Veja informações do perfil
  • Atualize o nome de usuário
  • Mudar o tema
  • Página de detalhes do usuário
• Página da lista de problemas
  • Search & filter issues by author, label, assignee, closed/open, title, mentions, etc. (Inspiration: https://github.com/openstatusHQ/openstatus, https://docs.github.com/en/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)
• Nova página de edição
  • Emitir crud (apenas pelo autor)
  • Comentários Crud
  • Menções
  • Emitir popovers (para visualizar problemas)
  • Vincular entre questões
  • Atribuir e atribuir problemas autônomos
• OpenGraph
  • Landing (Inspiração: https://github.com/trpc/trpc/blob/main/www/og-image/pages/api/landing.tsx)
  • Por repositório
  • Por usuário
  • Per Issue (inspiration: https://opengraph.githubassets.com/101e5bdeef8e959c800fab2aef88eef0b01b15d883e3e17c990bde8dfd67d6b3/trpc/trpc/issues/4306)
• Etiquetas Crud (só pode adicionar ou atualizar rótulos, sem exclusão)
• Página de notificações
  • Notificações Badge (Inspiração: https://gist.github.com/fredkiss3/ab918aee3977d681f0508537a44838c0, https://github.com/fredkiss3/bunrest)
  • Notificações para assinaturas de questões
  • Notificações para menções
  • Notificações para status de emissão
  • Notificações de filtro por status, título, fechado, etc.
  • Marque como feito, cancelada a inscrição
• Arquivos Hospedagem para repositórios (com um limite de armazenamento)
  • Arquivo Navegação de interface do usuário
  • Pesquisa de arquivos
• Lista de repositório
  • Lista de repositórios
  • Pesquise por repositórios
• Git Web UI
  • cometer história
  • viagem no tempo
  • Apoie os comandos git remote git push e Git
• Emissão Kanban Board (como os projetos do GitHub), para fechar um problema com um compromisso ou da interface do usuário
• CI/CD
  • CI com Docker, podemos inspirar -se no Gitlab

Pilha

• Próximo roteador de aplicativos
• Drague + banco de dados local do Postgres
• Hospedado a um VPS personalizado, consulte o fluxo de trabalho CI/CD de como está tudo implantado
• Tailwindcss para o estilo

Requisitos

• Nó> = v18.x
• pnpm> = v8.x
• Docker instalado para desenvolvimento local
• Um aplicativo Github registrado para autenticação de usuários

Como trabalhar no projeto?

1. Primeiro você tem que clonar o repositório

   git clone https://github.com/Fredkiss3/gh-next.git

2. Inicie a instância do Docker Compose para iniciar a instância do db + redis:

   docker-compose up -d --remove-orphans

3. Instale as dependências:

   pnpm install

4. Renomeie .env.example para .env.local e altere o arquivo para suas necessidades,

5. E inicie o projeto:

   pnpm run dev

   O aplicativo será exibido em http: // localhost: 3000.

6. Abra o código fonte e comece a balançar! ?

? Estrutura do projeto

Uma rápida olhada nos arquivos e diretórios de nível superior que você verá neste projeto.

  .
  ├── src/
  │    ├── app
  │    ├── actions
  │    ├── components
  │    ├── models
  │    └── lib/
  │         ├── client
  │         ├── server
  │         └── shared
  ├── biome.json
  ├── pnpm-lock.yaml
  └── tsconfig.json

1. src/app/ : Esta pasta contém todas as rotas e páginas do nosso aplicativo.

2. src/actions : Esta pasta contém toda a lógica do nosso aplicativo.

3. src/components : Esta pasta contém todos os componentes do nosso aplicativo.

4. src/models : Esta pasta contém todos os modelos de banco de dados do nosso aplicativo.

5. src/lib/ : Esta pasta contém UTILs e ajudantes usados em todo o nosso aplicativo:

   1. client : Esta pasta contém todos os utilitários que são apenas para clientes, geralmente usados pelos componentes do cliente. Ele contém principalmente ganchos

   2. server : esta pasta contém todos os utilitários que são apenas para servidor, para uso em componentes do servidor e ações do servidor. Ele também contém os esquemas de banco de dados dentro de db/schema

   3. shared : Esta pasta contém todos os utilitários compartilhados entre o servidor e o cliente, eles podem ser usados em qualquer lugar do aplicativo.

6. biome.json : Este arquivo contém a configuração do Bioma para ativar aformatação automática.

7. pnpm-lock.yaml : Este arquivo contém o bloqueio de dependências para o repositório.

8. tsconfig.json : Este arquivo contém a configuração do TypeScript, que são usados por todos os pacotes subjacentes

? Variáveis Env usadas

Nom	papel
SESSION_SECRET	String aleatória de comprimento de 32 chars usada para codificar o ID da sessão
REDIS_HTTP_URL	O URL para o Connect to Redis HTTP para uma loja de chave/valor
DATABASE_URL	O URL para a conexão com o banco de dados POSTRES
REDIS_HTTP_USERNAME	URL do servidor de arquivos local para armazenar valores de chave
REDIS_HTTP_PASSWORD	URL do servidor de arquivos local para armazenar valores de chave
GITHUB_CLIENT_ID	ID do cliente do GitHub armazenado para o nosso aplicativo usado para autenticar usuários com github
GITHUB_PERSONAL_ACCESS_TOKEN	Token do cliente Github armazenado para nosso aplicativo usado para autenticar usuários com github
GITHUB_REDIRECT_URI	URL para redirecionar quando um usuário foi autenticado
GITHUB_SECRET	Github Secret armazenado para o nosso aplicativo