gh next

Простой клон GitHub в next.js

Простой альтернативный открытый исходный код Github на GitHub (иронично, верно?)

Смотрите #84 для получения дополнительной информации о поддерживаемых функциях.

️ Этот проект находится в активной разработке ️

Ожидайте, что вещи сломаются.

Дорожная карта

Нажмите, чтобы увидеть больше

• Вход/вход
• Домашняя страница (контент README)
• Отзывчивый макет
• Страница настроек для переключения темы
• Страница Stargazers
• Смотрите информацию о профиле
  • Обновить имя пользователя
  • Изменить тему
  • Страница сведений пользователя
• Страница списка проблем
  • Проблемы поиска и фильтра автора, лейбла, правозащитника, закрытый/открытый, название, упоминания и т. Д. (Вдохновение: https://github.com/openstatushq/openstatus, https://docs.github.com/en/issues/tracking-your-work-with-issues/filtering-and-seas
• Новая страница выпуска
  • Выпустить Crud (только автором)
  • Комментарии Crud
  • Упоминания
  • Выпуск Popovers (для просмотра проблем)
  • Связывание между проблемами
  • Назначить и назначать проблемы
• Открытый граф
  • Посадка (Вдохновение: https://github.com/trpc/trpc/blob/main/www/og-image/pages/api/landing.tsx)
  • За репозиторий
  • За пользователя
  • По вопросу (Вдохновение: https://opengraph.githubassets.com/101e5bdeef8e959c800fab2aef88eef0b01b15d883e3e17c990bde8dfd67d6b3/trpc/trpc/issure/4306)
• Метки CRUD (может только добавлять или обновить этикетки, без удаления)
• Страница уведомлений
  • Значок уведомлений (Вдохновение: https://gist.github.com/fredkiss3/ab918aee3977d681f0508537a44838c0, https://github.com/fredkiss3/bunrest)
  • Уведомления о вопросах подписки
  • Уведомления для упоминаний
  • Уведомления о статусах выпуска
  • Фильтрующие уведомления по статусу, названию, закрытым и т. Д.
  • Марк как сделан, отписаться
• Хостинг файлов для репо (с лимитом хранения)
  • Файл просмотр пользовательского интерфейса
  • Поиск файлов
• Список репозитория
  • Список репо
  • Поиск репо
• Git Web UI
  • совершать историю
  • Путешествие во времени
  • Поддержка git push и git remote команды
• Выпустите Kanban Poard (например, проекты GitHub), чтобы закрыть проблему либо с помощью коммита, либо из пользовательского интерфейса
• CI/CD
  • Запуск CI с Docker, мы можем черпать вдохновение в Gitlab

Куча

• Следующий приложение маршрутизатор
• Rizzle + локальная база данных Postgres
• Размещен в пользовательском VPS, см. Рабочий процесс CI/CD для того, как все это развернуто
• Tailwindcss для стиля

Требования

• Узел> = v18.x
• pnpm> = v8.x
• Docker установлен для локальной разработки
• Зарегистрированное приложение GitHub для аутентификации пользователей

Как поработать над проектом?

1. Сначала вам нужно клонировать репозиторий

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

2. Запустите экземпляр Docker Compose, чтобы запустить экземпляр DB + Redis:

   docker-compose up -d --remove-orphans

3. Установите зависимости:

   pnpm install

4. Переименовать .env.example на .env.local и измените файл на ваши потребности,

5. И запустить проект:

   pnpm run dev

   Приложение будет отображаться по адресу http: // localhost: 3000.

6. Откройте исходный код и начните качаться! ?

? Структура проекта

Быстрый взгляд на файлы и каталоги верхнего уровня, которые вы увидите в этом проекте.

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

1. src/app/ : Эта папка содержит все маршруты и страницы нашего приложения.

2. src/actions : эта папка содержит всю логику нашего приложения.

3. src/components : эта папка содержит все компоненты нашего приложения.

4. src/models : эта папка содержит все модели БД нашего приложения.

5. src/lib/ : Эта папка содержит UTILS & Helpers, используемые в нашем приложении:

   1. client : эта папка содержит все утилиты, которые являются только клиентами, обычно используемыми клиентскими компонентами. Он содержит в основном крючки

   2. server : эта папка содержит все утилиты, которые являются только сервером, для использования в компонентах сервера и действиях сервера. Он также содержит схемы БД внутри db/schema

   3. shared : эта папка содержит все утилиты, которые используются между сервером и клиентом, их можно использовать в любом месте приложения.

6. biome.json : этот файл содержит конфигурацию для Biome для включения автоформатирования.

7. pnpm-lock.yaml : Этот файл содержит блокировку зависимостей для репо.

8. tsconfig.json : этот файл содержит конфигурацию для TypeScript, которая используется всеми базовыми пакетами

? Env Используются переменные

Номинальный	роль
SESSION_SECRET	Строка rance 32 chars длины, используемая для кодирования идентификатора сеанса
REDIS_HTTP_URL	URL -адрес для подключения к Redis http для хранения ключей/значений
DATABASE_URL	URL -адрес для подключения к базе данных Potres
REDIS_HTTP_USERNAME	URL -адрес локального файлового сервера для хранения значений ключей
REDIS_HTTP_PASSWORD	URL -адрес локального файлового сервера для хранения значений ключей
GITHUB_CLIENT_ID	Идентификатор клиента GitHub, хранящийся для нашего приложения, используемого для аутентификации пользователей с GitHub
GITHUB_PERSONAL_ACCESS_TOKEN	Github Client Token, хранящийся для нашего приложения, используется для аутентификации пользователей GitHub
GITHUB_REDIRECT_URI	URL на перенаправление, когда пользователь был аутентифицирован
GITHUB_SECRET	GitHub Secret хранится для нашего приложения