captable
0.0.5
＃1开源帽桌管理平台，替代卡塔，皮带轮，天使主义者和其他人。
了解更多 ”
重要的
我们设想了一个世界上，所有人都可以访问，安全和授权的世界。 Captable，Inc。旨在使盖帽表，证券和利益相关者互动的处理民主化。通过尖端的技术和对开放性的承诺，我们努力成为金融生态系统积极变化的催化剂。
？ Information （WIP） - Captable，Inc。可帮助您在几分钟内将公司与所有必要的法律文件和备案汇总。
？ Cap Table Management （WIP） - Captable，Inc。可帮助您跟踪公司的所有权结构，包括谁拥有公司的百分比，已发行了多少股票/期权等等。
✅筹款- Captable，Inc。可以帮助您筹集资金，无论是签署标准或定制安全，还是创建和管理筹款回合，跟踪投资者的承诺等等。
✅投资者更新- 通过向您的公司的进度定期更新，使您的投资者和团队成员感到高兴。
✅ESIGN文件- 签名安全，NDA，合同，信件或任何类型的带有可捕获标志的文件。
✅数据室- Captable，Inc。提供了一个安全的虚拟数据室，您可以在其中存储重要的文件并与投资者，员工和其他利益相关者共享。
安装Docker＆Docker组成
叉子和克隆分叉存储库
安装节点和PNPM。 （选修的）
将.env.example复制为.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 compose up将启动各自端口上的所有服务。
http://localhost:1025http://localhost:5432http://localhost:5555经常使用的命令
docker compose up - 开始开发环境docker compose down - 停止开发环境docker compose logs -f查看运行服务的日志docker compose up --build - 重建Docker Imagedocker 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将.env.example复制为.env
cp .env.example .env安装最新版本的节点和PNPM
安装最新版本的Postgres数据库
安装用于SMTP的邮件和电子邮件拦截
在Postgres captable中创建数据库
带有数据库凭据的更新.env文件的DATABASE_URL
快速启动，您也可以使用supabase数据库或霓虹灯。
要在本地模拟文件存储，请通过Homebrew或任何其他软件包管理器安装minio 。
brew install minio一旦安装了Minio
minio server start --console-address " :9002 "这将启动Minio服务器
Minio API将在http://127.0.0.1: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
并创建两个名称：
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:1025http://localhost:5432经常使用的命令
pnpm dev - 启动开发服务器pnpm email:dev - 启动邮件服务器pnpm db:migrate - 运行数据库迁移pnpm db:seed - 种子数据库做出提交时，请确保遵循传统的提交准则，即以壮举为feat: ， fix: ，fix：， chore: ， docs: ，et et the Message：，等...
git add < file > && git commit -m " feat/fix/chore/docs: commit message " 完成后
进行提交并将代码推到github叉上，然后进行拉装。
感谢您的贡献。很多❤️
