ホーム>プログラミング関連>その他のソースコード
ダウンロード

コド

コーダーのためのスペース

Codúは、大小を問わず、プロジェクトを学び、共有し、サポートするWeb開発者の究極のコミュニティです。スキルを磨き、ポートフォリオを構築するのに最適な場所です。コドでは、私たちは皆、お互いがウェブ開発者として成長するのを助けるためにここにいます。さらに、Codúは、次の大きなプロジェクトのためにコラボレーターを簡単に見つけることができます。

会話に参加してください

私たちには、Discordで素晴らしいコミュニティが成長しています。参加するにはここをクリックしてください！

インストール

  1. プロジェクトをフォークします
  2. git clone with git clone https://github.com/YOUR_USERNAME/codu.git
  3. Project Directory cd coduに移動します。
  4. 依存関係をインストールします： 
npm install
  • 依存関係のインストールに問題がある場合は、 .nvmrcで定義されているノードバージョンに対してノードバージョンを確認してください。 nvmを使用している場合は、依存関係をインストールする前にnvm use実行できます。
  1. .envファイルを作成し、次の変数を追加します。 cat sample.env > .envを使用して、 sample.envの内容をコピーできます。 
 # This default value is if you run our local docker-compose.yml file to create the database.
DATABASE_URL=postgresql://postgres:[email protected]:5432/postgres
# Setup your GitHub ID & Secret on GitHub: https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps
# For development, make sure you set up this with a Homepage URL of http://localhost:3000/ and an Authorization callback URL of http://localhost:3000/api/auth
GITHUB_ID=YOUR_GITHUB_APP_ID
GITHUB_SECRET=YOUR_GITHUB_APP_SECRET
NEXTAUTH_URL=http://localhost:3000/api/auth

それらのセットアップに関するより詳細なガイドについては、環境変数セクションに移動します。

注：先に進む前に、データベースが実行されていることを確認してください。

  1. 実行して、Drizzleでデータベース内のテーブルをセットアップします。 
npm run db:migrate

完全なコマンドは、package.jsonファイルに表示されます。

  1. 実行して、いくつかの模擬データを使用してデータベースをシードします。 
npm run db:seed

完全なコマンドは、package.jsonファイルに表示されます。

  1. 最後に、開発サーバーを実行します。 
npm run dev

上記のコマンドが完了したら、ブラウザでhttp：// localhost：3000に移動して結果を確認します。

pages/index.tsx変更して、旅を始めることができます。 Auto-Update機能を使用すると、ファイルを編集するときにページが更新されます。

pages/apiディレクトリは/api/*にマッピングされます。このディレクトリのファイルは、Reactページの代わりにAPIルートとして扱われます。

APIルートの詳細については、こちらをご覧ください。

環境変数

database_url

DATABASE_URLは、PostgreSQLデータベース（バージョン15.0）への接続文字列です。

デフォルトでは、 docker-compose.ymlファイルからDockerを使用してローカルに実行されているデータベースを指します。

このファイルを実行するには、Dockerがインストールされ、Dockerが実行されていることを確認してください。

Command docker compose up実行します。

または、PostgreSQLがローカルで実行されている場合は、ローカル接続文字列を使用したり、Supabaseのような無料サービスからつかむことができます。

github_idおよびgithub_secret

現在、GitHubを介した認証のみを許可しています。これを有効にするには、 GITHUB_IDとGITHUB_SECRET値が必要です。

githubでgithub id＆secretをセットアップします。

  • ここをクリックして、新しいOAuthアプリをセットアップし、以下に示すように詳細を入力してください。

開発のために、ホームページURLでこれを設定してください

 http://localhost:3000/

およびの承認コールバックURL 

 http://localhost:3000/api/auth

[登録アプリケーション]ボタンをクリックしたら、 GITHUB_ID表示され、新しいクライアントの秘密を生成できるようにする必要があります。秘密を生成した後、この値を.envファイルにコピーすることを確認してください。ページを更新したら、この値を再度見ることができないためです。

GitHubのドキュメントでOAuthの承認の詳細については、こちらをご覧ください。

パスワードレスAUTHをローカルに設定します

パスワードレスログインをローカルで使用するには、 ACCESS_KEYとSECRET_KEY値が必要です。

これらの値を入力する方法を確認するには、ここの例の.envファイルをご覧ください。

注：現在、SNSサービスのAWSリージョンは「Eu-West-1」に強制されています。 SNSサービスが別の地域にある場合、これを変更する必要がある場合があります。

nextauth_url

ここでデフォルト値を変更する必要はありません。これは、サイトの認証URLとしてNext Authが使用する変数です。 

 NEXTAUTH_URL=http://localhost:3000/api/auth

例.ENVファイルはここにあります。これを.envに変更して開始できます。

？‍貢献ガイドライン

  • 貢献は大歓迎です。貢献により、オープンソースコミュニティは、学習、インスピレーション、および作成する素晴らしい場所になります。
  • リポジトリに貢献するための貢献ガイドラインをご覧ください。含まれています
    • 貢献する方法
    • プルリクエストを作成する方法
    • テストを実行します
    • コミットメッセージのスタイルガイド

？貢献する前提条件のスキル

  • git

？ドキュメントの貢献

  • マークダウン

？コードの貢献

  • 反応します
  • next.js
  • postgreSql
  • 追い風
  • 霧雨

追加のリソース

next.jsの詳細については、次のリソースをご覧ください。

  • next.jsドキュメント - next.js機能とAPIについて学びます。
  • next.jsを学ぶ - インタラクティブなnext.jsチュートリアル。

編集者ドキュメント

編集者のショートカットとホットキーについて学ぶには、このドキュメントを確認できます。

  • MarkDocエディターのホットキーとショートカット

？ E2Eテスト

E2Eテストの詳細については、こちらの専用ドキュメントを参照してください。

？問題

Codúの改善に関するアイデアを議論するために、問題を開くことを歓迎します。強化が奨励され、高く評価されています。

拡大する
追加情報
関連アプリ
おすすめ
関連情報 すべて