captable
0.0.5
＃1オープンソースキャップテーブル管理プラットフォーム、カルタ、プーリー、アンジェリストなどに代わるもの。
もっと詳しく知る "
重要
私たちは、キャップテーブル管理にアクセスしやすく、安全で、すべての人が力を与える世界を想像しています。 Captable、Inc。は、CAPテーブル、証券、および利害関係者のやり取りの取り扱いを民主化することを目指しています。最先端のテクノロジーと開放性へのコミットメントを通じて、私たちは金融エコシステムの前向きな変化の触媒となるよう努めています。
？ Incorporation （WIP）-Captable、Inc。は、必要なすべての法的文書とファイリングが処理されて、数分で会社を組み込むのに役立ちます。
？ Cap Table Management （WIP）-Captable、Inc。は、会社のどの割合を所有しているか、発行された株式/オプションの量など、会社の所有構造を追跡するのに役立ちます。
undraise -Captable、Inc。は、署名標準であろうとカスタムセーフであろうと、資金調達ラウンドの作成と管理、投資家のコミットメントの追跡など、資金を調達するのに役立ちます。
✅投資家の最新情報- 会社の進捗状況に関する定期的な更新を送信することで、投資家とチームメンバーを喜ばせます。
signドキュメント- 署名安全、nda、契約、offereレター、またはキャプテンサイン付きのあらゆる種類のドキュメント。
✅データルーム-Captable、Inc。は、重要な文書を保存し、投資家、従業員、その他の利害関係者と共有できる安全な仮想データルームを提供しています。
Docker＆Docker Composeをインストールします
フォーク＆クローンフォークリポジトリ
ノードとPNPMをインストールします。 （オプション）
copy .env.example to .env
cp .env.example .env次のコマンドを実行して、開発環境を開始します
# With pnpm installed
pnpm dx
# Without pnpm installed
docker compose up
次のコマンドを実行して、データベースを移行してシードします
docker compose exec app pnpm db:migrate
docker compose exec app pnpm db:seed
注意Dockerfileまたはcompose.ymlに変更を加えるたびに、
docker compose up --buildを実行してDocker画像を再構築する必要があります。
docker compose upすると、それぞれのポートですべてのサービスが開始されます。
http://localhost:1025で行われますhttp://localhost:5432で行われますhttp://localhost:5555で行われます頻繁に使用されるコマンド
docker compose up開発環境を開始しますdocker compose down開発環境を停止しますdocker compose logs -f実行中のサービスのログを表示するdocker compose up --buildますdocker compose run app pnpm db:migrate - データベースの移行を実行するdocker compose run app pnpm db:seed - データベースをシードしますこれはMac OSでテストされており、非常にうまく機能しています。 Linux/Windows/WSLを使用している場合は、追加の依存関係をインストールする必要がある場合があります。
リポジトリをフォークします
リポジトリをクローンします
git clone https://github.com/ < your-github-name > /captable.git copy .env.example to .env
cp .env.example .envノードとPNPMの最新バージョンをインストールします
Postgresデータベースの最新バージョンをインストールします
SMTP用のMailPitと電子メールインターセプトをインストールします
Postgresデータベースにデータベースcaptableを作成します
データベース資格情報を備えた.envファイルのDATABASE_URLを更新します
クイックスタートのために、SupabaseデータベースまたはNeonも使用できます。
ファイルストレージをローカルにシミュレートするには、HomeBrewまたはその他のパッケージマネージャーを介してminioをインストールします。
brew install minioMinioがインストールされたら実行します
minio server start --console-address " :9002 "これにより、Minioサーバーが開始されます
Minio APIはhttp://127.0.0.1:9000 9000およびで利用できます
Minio Web GUIはhttp://127.0.0.1:9002で入手できます。
これらのエンドポイントが端末に表示されたら、次の.envを更新します。
UPLOAD_ENDPOINT= " http://127.0.0.1:9000 " # should match minio api server's endpoint
NEXT_PUBLIC_UPLOAD_DOMAIN= " http://127.0.0.1:9000 " # should match minio api server's endpoint
UPLOAD_REGION= " us-east-1 " # don't change it
UPLOAD_ACCESS_KEY_ID= " minioadmin " # by default minio username is "minioadmin"
UPLOAD_SECRET_ACCESS_KEY= " minioadmin " # by default minio password is "minioadmin"
UPLOAD_BUCKET_PUBLIC= " captable-public-bucket "
UPLOAD_BUCKET_PRIVATE= " captable-private-bucket "この後、Minio Web GUI（ http://127.0.0.1:9002 ）に移動してログインします。
ユーザー名： minioadmin
パスワード： minioadmin
名前で2つのバケツを作成します。
captable-public-bucketとcaptable-private-bucket 、
これは、 UPLOAD_BUCKET_PUBLICとUPLOAD_BUCKET_PRIVATE envの値と一致するはずです。
そして、Minioのセットアップを完了する必要があります。
依存関係をインストールするには、次のコマンドを実行します
pnpm install次のコマンドを実行して、データベースを移行してシードします
pnpm db:migrate
pnpm db:seed次のコマンドを実行して、開発サーバーを起動します
pnpm dev
# On a different terminal, run the following command to start the mail server
pnpm email:devhttp://localhost:1025で行われますhttp://localhost:5432で行われます頻繁に使用されるコマンド
pnpm dev開発サーバーを起動しますpnpm email:devメールサーバーを起動しますpnpm db:migrate - データベースの移行を実行しますpnpm db:seed - データベースをシードしますコミットを行うときは、従来のコミットガイドラインに従ってください。つまりfeat: 、 fix: 、 chore: 、 docs: 、etc ...
git add < file > && git commit -m " feat/fix/chore/docs: commit message " 終わったら
コミットして、コードをgithubフォークにプッシュし、プルリクエストを作成します。
貢献してくれてありがとう。多くの❤️
