hackyx

ハッキックス

https://hackyx.io

Hackyx はサイバーセキュリティのための検索エンジンです。

コミュニティ向けに構築されているため、誰でも新しいコンテンツを追加できます。

このプロジェクトの目的は、CTF の記事、記事、バグ報奨金レポートなど、IT セキュリティに関連するリソースを簡単に見つけられるようにすることです。

新しいコンテンツを追加する

新しいコンテンツを追加するには、メイン Web サイト https://hackyx.io のフォームに記入するだけです。

「新しいコンテンツを追加」ページの下部にあります。

その後、コンテンツを検証するために手動レビューが行われます。検証されると、コンテンツが検索エンジンに追加されます。

Hackyx のローカル開発セットアップ

Hackyx プロジェクトをローカル開発用に設定するには、次の手順に従います。

環境設定

env.example.txtで提供されるテンプレートに基づいて.envファイルを作成します。

GitHub OAuth セットアップ

GitHub 開発者設定の GitHub 開発者設定で OAuth アプリケーションを作成し、 GITHUB_IDとGITHUB_SECRET取得します。アプリケーションを設定するときは、次の情報を指定する必要があります。

• ホームページ URL : アプリケーションのベース URL (例: http://localhost:3000 )。
• 認可コールバック URL : OAuth 認証の認可コールバック URL。 http://localhost:3000/api/auth/callback/githubである必要があります。 GITHUB_IDとGITHUB_SECRET .envファイルに追加します。

ドッカーサービス

Docker Compose を使用して、必要なサービス (PostgreSQL、Typesense、および Browserless) を開始します。

 docker-compose -f docker-compose.dev.yml up

Typesenseの初期化

Typesense 初期化スクリプトを実行します。

 npm run init-typesense

出力から API キーをコピーし、 .envファイルのNEXT_PUBLIC_TYPESENSE_SEARCH_API_KEYに貼り付けます。

データベースの初期化

Prisma クライアントを生成し、スキーマをデータベースにプッシュします。

 npx prisma generate
npx prisma db push

データベースUI

オプションで、Prisma Studio を使用してデータベースを表示および管理できます。

 npx prisma studio

これらの手順により、ローカル開発環境で Hackyx を使用できるようになります。