captable
0.0.5
# 1 Plateforme de gestion de table de casquette open source, une alternative à Carta, Pulley, Angelist et autres.
Apprendre encore plus "
Important
Nous envisageons un monde où la gestion de la table de plafond est accessible, sécurisée et habilitante pour tous. Capable, Inc. vise à démocratiser la gestion des tables de plafond, des titres et des interactions des parties prenantes. Grâce à la technologie de pointe et à un engagement envers l'ouverture, nous nous efforçons d'être le catalyseur d'un changement positif dans les écosystèmes financiers.
? Incorporation (WIP) - Capable, Inc. vous aide à intégrer votre entreprise en quelques minutes, avec tous les documents juridiques et dépôts nécessaires.
? CAP Table Management (WIP) - Capable, Inc. vous aide à garder une trace de la structure de propriété de votre entreprise, notamment qui possède quel pourcentage de l'entreprise, la quantité d'actions / options a été émise, et plus encore.
✅ Fundaise - Capable, Inc. peut vous aider à lever des capitaux, que ce soit sa norme de signature ou sa sécurité personnalisée ou la création et la gestion des rondes de collecte de fonds, le suivi des engagements des investisseurs, etc.
✅ Mises à jour des investisseurs - Ravi de plaisir de vos investisseurs et des membres de l'équipe en leur envoyant des mises à jour régulières sur les progrès de votre entreprise.
✅ Documents ESign - Signe Safe, NDA, Contracts, Offre Letters ou tout type de documents avec signe capable.
✅ Rooms de données - Capable, Inc. fournit une salle de données virtuelle sécurisée où vous pouvez stocker des documents importants et les partager avec des investisseurs, des employés et d'autres parties prenantes.
Installer Docker & Docker Compose
Fork & clone le référentiel fourchu
Installez le nœud et PNPM. (facultatif)
Copier .env.example à .env
cp .env.example .envExécutez la commande suivante pour démarrer l'environnement de développement
# With pnpm installed
pnpm dx
# Without pnpm installed
docker compose up
Exécutez la commande suivante pour migrer et semer la base de données
docker compose exec app pnpm db:migrate
docker compose exec app pnpm db:seed
Remarque Chaque fois que vous apportez des modifications à dockerfile ou compose.yml, vous devez reconstruire l'image Docker en exécutant
docker compose up --build
Running docker compose up lancera tous les services sur leurs ports respectifs.
http://localhost:1025http://localhost:5432http://localhost:5555Commandes fréquemment utilisées
docker compose up - Démarrez l'environnement de développementdocker compose down - Arrêtez l'environnement de développementdocker compose logs -f - Afficher les journaux des services en cours d'exécutiondocker compose up --build - Reconstruire l'image Dockerdocker compose run app pnpm db:migrate - exécuter les migrations de base de donnéesdocker compose run app pnpm db:seed - Seed the Database Base Cela a été testé sur Mac OS et fonctionne très bien. Si vous utilisez Linux / Windows / WSL, vous devrez peut-être installer des dépendances supplémentaires.
Fourchez le référentiel
Cloner le référentiel
git clone https://github.com/ < your-github-name > /captable.git Copier .env.example à .env
cp .env.example .envInstallez la dernière version de Node et PNPM
Installez la dernière version de la base de données Postgres
Installez Mailpit pour SMTP et interception par e-mail
Créer une base de données captable dans la base de données Postgres
Mettre à jour DATABASE_URL du fichier .env avec des informations d'identification de base de données
Pour un démarrage rapide, vous pouvez également utiliser la base de données Supabase ou le néon.
Pour simuler le stockage de fichiers localement, installez minio via Homebrew ou tout autre gestionnaire de packages.
brew install minioUne fois Minio installé
minio server start --console-address " :9002 " Cela commencera Minio Server
API Minio sera disponible sur http://127.0.0.1:9000 et
Minio Web GUI sera disponible sur http://127.0.0.1:9002 .
Une fois que vous voyez ces points de terminaison dans le terminal, mettez à jour les .env suivants:
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 " Après cela, allez à Minio Web GUI ( http://127.0.0.1:9002 ) et connectez-vous:
Nom d'utilisateur: minioadmin
Mot de passe: minioadmin
et créez deux seaux avec le nom:
captable-public-bucket et captable-private-bucket ,
Cela devrait correspondre UPLOAD_BUCKET_PUBLIC et UPLOAD_BUCKET_PRIVATE des valeurs d'env.
Et vous devez en avoir terminé avec la configuration Minio.
Exécutez la commande suivante pour installer les dépendances
pnpm installExécutez la commande suivante pour migrer et semer la base de données
pnpm db:migrate
pnpm db:seedExécutez la commande suivante pour démarrer le serveur de développement
pnpm dev
# On a different terminal, run the following command to start the mail server
pnpm email:devhttp://localhost:1025http://localhost:5432Commandes fréquemment utilisées
pnpm dev - Démarrez le serveur de développementpnpm email:dev - Démarrez le serveur de messageriepnpm db:migrate - exécuter les migrations de base de donnéespnpm db:seed - Semence la base de données Lorsque vous faites des commits, assurez-vous de suivre les directives de validation conventionnelles, c'est-à-dire en avant le message avec feat: , fix: , chore: , docs: etc ...
git add < file > && git commit -m " feat/fix/chore/docs: commit message " Quand tu as fini
Faites un engagement et poussez votre code à votre fourche github et faites une nouvelle demande.
Merci pour vos contributions. Beaucoup de ❤️
