twenty/README.md

<br>
<p align="center">
  <a href="https://www.twenty.com">
    <img src="./docs/static/img/logo-square-dark.svg" width="100px" alt="Twenty logo" />
  </a>
</p>

<h2 align="center" >A Modern Open Source CRM </h3>
<p align="center">Crafted with Precision. Built for Success.</p>

<p align="center">🌐 <a href="https://twenty.com">Website</a> · 📚 <a href="https://docs.twenty.com">Documentation</a> · 📖 <a href="https://twenty.com/story">Our Story</a> · 💬 <a href="https://discord.gg/cx5n4Jzs57">Discord</a> · ✏️ <a href="https://www.figma.com/file/xt8O9mFeLl46C5InWwoMrN/Twenty">Figma</a><p>
<br />

<p align="center">
  <a href="https://www.twenty.com">
    <picture>
      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/preview-dark.png">
      <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/preview-light.png">
      <img src="./docs/static/img/preview-light.png" alt="Companies view" />
    </picture>
  </a>
</p>

# Quickstart
Access the alpha version at [app.twenty.com](https://app.twenty.com). Click-to-deploy buttons for Render and Railway are coming soon.

For local setup, refer to [the documentation](https://docs.twenty.com/developer/local-setup). Expect a quick and easy startup.

# About
We are building an Open Source CRM designed to be: enjoyable to use, easily extendable, and perfectly in-sync with your data. 

Twenty was created as a Public Benefits Company. This means we're legally bound to consider the impact of our decisions not just on shareholders, but also on society.

Our belief is simple: **great companies focus on helping people** and meeting their users' needs above all. The decision to go open source was therefore a natural one for us. It fits with our aim to do what's right and with our goals for the business:

**For our users:**
- We are committed to complete transparency regarding what we are building, allowing you to take a look inside and observe the intricate machinery in action.
- This enables you to be a decisive actor of the roadmap by contributing or building your own tool.
  
**For the developer community:**
- We offer a self-hosted CRM solution that you can use for free, keeping your data on your own servers.
- We are developing a collection of reusable components, such as tables or kanban boards (coming soon).
- We are introducing a new approach to CRM extensibility, one that can be managed by your engineering team instead of relying on external consultants (coming soon).


# Features
We are currently in the development phase of Twenty's alpha version.  
Don't hesitate to flag a specific need by creating an issue.   

Below are the features we have implemented to date.

## Add, filter, sort, edit and track customers:

<p align="center">
    <picture>
      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/visualise-customer-dark.png">
      <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/visualise-customer-light.png">
      <img src="./docs/static/img/preview-light.png" alt="Companies view" />
    </picture>
</p>

## Create one or several opportunities for each company:

<p align="center">
    <picture>
      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/follow-your-deals-dark.png">
      <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/follow-your-deals-light.png">
      <img src="./docs/static/img/preview-light.png" alt="Companies view" />
    </picture>
</p>

## Rich notes (and soon tasks) that are displayed in a timeline:

<p align="center">
    <picture>
      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/rich-notes-dark.png">
      <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/rich-notes-light.png">
      <img src="./docs/static/img/preview-light.png" alt="Companies view" />
    </picture>
</p>

## Navigate quickly through the app using keyboard shortcuts and search:

<p align="center">
    <picture>
      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/shortcut-navigation-dark.png">
      <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/shortcut-navigation-light.png">
      <img src="./docs/static/img/preview-light.png" alt="Companies view" />
    </picture>
</p>

# Upcoming features

Coming next:  
⚙️  A notification center<br>
⚙️  More standard fields<br>
⚙️  AI/LLM integration to Notes<br>
⚙️  More pipelines and table customization<br>
⚙️  A lot of bug fixes and other improvements<br>
⚙️  Auto-logging emails<br>

Coming later this year:  
📅  Advanced search and filters<br>
📅  Data connectors<br>
📅  Custom fields<br>
📅  Custom objects<br>
📅  +++<br>

Track planning on [Github Projects](https://github.com/orgs/twentyhq/projects/1) and help us prioritising by upvoting or creating [issues](https://github.com/twentyhq/twenty/issues)

# Documentation
The doc is available on [docs.twenty.com](https://docs.twenty.com).

If you have any question feel free to ask on our [Discord](https://discord.gg/cx5n4Jzs57).

# Helping us
- The easiest way to help us is to star the repo and helping us getting visibility.
- Contributions are, of course, most welcome!  
It doesn't have to be code, you could create an [issue](https://github.com/twentyhq/twenty/issues) to report a bug you've spotted, join [discussions](https://github.com/twentyhq/twenty/discussions), [Discord](https://discord.gg/cx5n4Jzs57) or write [documentation](https://docs.twenty.com/).


# Office hours
Want to meet the team? Get direct support?
Feel free to book a slot during our office hours.

<a href="https://cal.com/team/twenty?utm_source=banner&utm_campaign=oss">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://cal.com/book-with-cal-dark.svg">
    <source media="(prefers-color-scheme: light)" srcset="https://cal.com/book-with-cal-light.svg">
    <img alt="Book us with Cal.com" src="https://cal.com/book-with-cal-light.svg" height="40">
  </picture>
</a>