captable
0.0.5
Plataforma de gestión de mesa de tapa de código abierto #1, una alternativa a la Carta, la Polea, Angelistes y otros.
Aprenda más »
Importante
Imaginamos un mundo donde la gestión de la tabla CAP es accesible, segura y empoderadora para todos. Captable, Inc. tiene como objetivo democratizar el manejo de tablas de capitalización, valores e interacciones de las partes interesadas. A través de la tecnología de vanguardia y un compromiso con la apertura, nos esforzamos por ser el catalizador del cambio positivo en los ecosistemas financieros.
? Incorporation (WIP) - Captable, Inc. lo ayuda a incorporar su empresa en minutos, con todos los documentos y presentaciones legales necesarios.
? CAP Table Management (WIP) - Captable, Inc. lo ayuda a realizar un seguimiento de la estructura de propiedad de su empresa, incluido quién posee qué porcentaje de la compañía, cuántas acciones/opciones se han emitido y más.
✅ Recaudación de fondos : Captable, Inc. puede ayudarlo a recaudar capital, ya sea su firma estándar o personalizada o creando y administrando rondas de recaudación de fondos, seguimiento de compromisos de inversores y más.
✅ Actualizaciones de inversores : deleite a sus inversores y miembros del equipo enviándoles actualizaciones regulares sobre el progreso de su empresa.
✅ Documentos de ESign : firmar seguros, NDA, contratos, cartas ofere o cualquier tipo de documento con signo capitable.
✅ Salas de datos : Captable, Inc. proporciona una sala de datos virtual segura donde puede almacenar documentos importantes y compartirlos con inversores, empleados y otras partes interesadas.
Instalar Docker y Docker Compose
Bifurca y clon el repositorio bifurcado
Instale el nodo y PNPM. (opcional)
Copiar .env.example a .env
cp .env.example .envEjecute el siguiente comando para iniciar el entorno de desarrollo
# With pnpm installed
pnpm dx
# Without pnpm installed
docker compose up
Ejecute el siguiente comando para migrar y sembrar la base de datos
docker compose exec app pnpm db:migrate
docker compose exec app pnpm db:seed
Tenga en cuenta cada vez que realiza cambios en DockerFile o Compose.yml, debe reconstruir la imagen de Docker ejecutando
docker compose up --build
Ejecutar docker compose up comenzará todos los servicios en sus respectivos puertos.
http://localhost:1025http://localhost:5432http://localhost:5555Comandos de uso frecuente
docker compose up - Inicie el entorno de desarrollodocker compose down - Detener el entorno de desarrollodocker compose logs -f - Ver registros de los servicios en ejecucióndocker compose up --build - -Build -reconstruye la imagen de Dockerdocker compose run app pnpm db:migrate - Ejecutar migraciones de bases de datosdocker compose run app pnpm db:seed - Semilla La base de datos Esto se ha probado en Mac OS y funciona muy bien. Si está utilizando Linux/Windows/WSL, es posible que deba instalar algunas dependencias adicionales.
Bifurca el repositorio
Clonar el repositorio
git clone https://github.com/ < your-github-name > /captable.git Copiar .env.example a .env
cp .env.example .envInstale la última versión de Node y PNPM
Instale la última versión de la base de datos de Postgres
Instale MailPit para SMTP e intercepción por correo electrónico
Crear una base de datos captable en la base de datos de Postgres
Actualizar DATABASE_URL de .env con credenciales de la base de datos
Para un inicio rápido, también puede usar la base de datos Supabase o el neón.
Para simular el almacenamiento de archivos localmente, instale minio a través de HomeBrew o cualquier otro Administrador de paquetes.
brew install minioUna vez que Minio está instalado, ejecute
minio server start --console-address " :9002 " Esto iniciará Minio Server
Minio API estará disponible en http://127.0.0.1:9000 y
Minio Web GUI estará disponible en http://127.0.0.1:9002 .
Una vez que vea estos puntos finales en la terminal, actualice el siguiente .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 " Después de esto, vaya a Minio Web GUI ( http://127.0.0.1:9002 ) e inicie sesión:
Nombre de usuario: minioadmin
Contraseña: minioadmin
y crea dos cubos con el nombre:
captable-public-bucket y captable-private-bucket ,
Esto debería coincidir con los valores de UPLOAD_BUCKET_PUBLIC y UPLOAD_BUCKET_PRIVATE env.
Y deberías terminar con Minio Configuración.
Ejecute el siguiente comando para instalar dependencias
pnpm installEjecute el siguiente comando para migrar y sembrar la base de datos
pnpm db:migrate
pnpm db:seedEjecute el siguiente comando para iniciar el servidor de desarrollo
pnpm dev
# On a different terminal, run the following command to start the mail server
pnpm email:devhttp://localhost:1025http://localhost:5432Comandos de uso frecuente
pnpm dev - Inicie el servidor de desarrollopnpm email:dev - Inicie el servidor de correopnpm db:migrate - Ejecutar migraciones de bases de datospnpm db:seed - Semilla La base de datos Al realizar comodidades, asegúrese de seguir las pautas de confirmación convencionales, es decir, prependiendo el mensaje con feat: , fix: , chore: , docs: , etc ...
git add < file > && git commit -m " feat/fix/chore/docs: commit message " Cuando hayas terminado
Haz una compromiso y empuja tu código a tu tenedor GitHub y haz una solicitud de extracción.
Gracias por tus contribuciones. Mucho ❤️
