Skip to content

The Open Source alternative to Carta and Pulley.

License

Notifications You must be signed in to change notification settings

daallgeier/opencap

 
 

Repository files navigation

OpenCap cover image

OpenCap

An open source alternative to Carta and Pulley

Learn more »

Github Twitter CI License Join us on Discord

OpenCap will follow the Open Cap Table Coalition format, an open source standard to prevent lock-in and keep lawyer fees low. No promises.

✨ Contributors

  • Don't forget to leave a star ⭐️
  • We ❤️ contributors! Feel free to contribute to this project!.
  • Any contributions you make are truly appreciated.
  • Let's continue contributing to keep the community active and growing.
  • Let's collaborate on Discord community channel.

A table of avatars from the project's contributors

Stack

Developers

Follow the steps below to stand the app up locally. You can use yarn, pnpm, or npm to run the commands.

1. Install dependencies.

# Using yarn
yarn i

# Using pnpm
pnpm i

# Using npm
npm i

2. Spin up a local database.

First, ensure Docker is running.

# Using yarn
yarn docker:start

# Using pnpm
pnpm docker:start

# Using npm
npm run docker:start

Generate tables and the Prisma client.

npx prisma migrate dev

To see what's in your database, run Prisma Studio:

# Using yarn
yarn db:studio

# Using pnpm
pnpm db:studio

# Using npm
npm run db:studio

3. Seed some data (For dev environment)

# Using yarn
yarn db:seed

# Using pnpm
pnpm db:seed

# Using npm
npm run db:seed

4. Run the web app

# Using yarn
yarn dev

# Using pnpm
pnpm dev

# Using npm
npm run dev

5. Install and run SMTP server

Mailpit or something similar can be used intercept emails in development.

# Using yarn
yarn smpt

# Using pnpm
pnpm smpt

# Using npm
npm run smpt

Open your browser to the URLs given by the web app and studio processes. You're up and running, good job! 🎉

One-click deploy

Coming soon to a PaaS near you:

About

The Open Source alternative to Carta and Pulley.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 94.4%
  • PLpgSQL 2.6%
  • JavaScript 2.4%
  • Other 0.6%