mirror of
https://github.com/lingble/twenty.git
synced 2025-10-29 20:02:29 +00:00
Updated the Read.me for the HN release (#737)
* Update README.md --------- Co-authored-by: Charles Bochet <charles@twenty.com>
This commit is contained in:
121
README.md
121
README.md
@@ -9,60 +9,115 @@
|
|||||||
<h2 align="center" >A modern CRM Alternative</h3>
|
<h2 align="center" >A modern CRM Alternative</h3>
|
||||||
<p align="center">Engineer-Designed. Business-Ready.
|
<p align="center">Engineer-Designed. Business-Ready.
|
||||||
|
|
||||||
|
|
||||||
</p>
|
</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">Story</a></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">Story</a> · <a href="https://discord.com/invite/3Wneyvmn">Discord</a></p>
|
||||||
<br />
|
<br />
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://www.twenty.com">
|
<a href="https://www.twenty.com">
|
||||||
<picture>
|
<picture>
|
||||||
<source media="(prefers-color-scheme: dark)" srcset="./docs/static/img/preview-dark.png">
|
<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="./docs/static/img/preview-light.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" />
|
<img src="./docs/static/img/preview-light.png" alt="Companies view" />
|
||||||
</picture>
|
</picture>
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
# About
|
# About
|
||||||
Twenty is an Open Source CRM designed to be:
|
At Twenty, we are building an Open Source CRM designed to be: Enjoyable to use, easily extendable, perfectly in-sync with your data. We think that being open source will better serve our customer needs and could also benefit the open source community.
|
||||||
- Easily extendable
|
|
||||||
- Perfectly in-sync with your data
|
**For our users:**
|
||||||
- Crafted with care and enjoyable to use
|
- Transparency on what we are building.
|
||||||
|
- An opportunity to be a decisive actor of your own tool by contributing to the roadmap.
|
||||||
|
|
||||||
|
**For the community:**
|
||||||
|
- A CRM you can self-host for free under AGPL license
|
||||||
|
- The power of an Open-Source project backed by a funded company
|
||||||
|
- Reusuable components such as tables or kanban
|
||||||
|
|
||||||
# Helping us
|
# Helping us
|
||||||
- The easiest way to help us is to star the repo and helping us getting visibility
|
- 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 also create an issue to report a bug you've spotted, join discussions or write documentation.
|
- Contributions are, of course, most welcome! It doesn't have to be code, you could also create an [issue](https://github.com/twentyhq/twenty/issues) to report a bug you've spotted, join [discussions](https://github.com/twentyhq/twenty/discussions) or write documentation.
|
||||||
|
|
||||||
# Quickstart
|
# Quickstart
|
||||||
Soon, you should be able to try a demo directly on [app.twenty.com](https://app.twenty.com), our cloud offering with a generous free tier. We'll also release click-to-deploy buttons for Render and Railway.
|
You can access and use the alpha version on [app.twenty.com](https://app.twenty.com), our cloud offering. We'll also release click-to-deploy buttons for Render and Railway.
|
||||||
|
|
||||||
In the meantime, you can check [the documentation](https://docs.twenty.com/start/local-setup). It shouldn't take more than a few minutes to install locally.
|
In the meantime, you can check [the documentation](https://docs.twenty.com/start/local-setup). It shouldn't take more than a few minutes to install locally.
|
||||||
|
|
||||||
# Progress
|
|
||||||
We are currently in the development phase of Twenty's alpha version:
|
|
||||||
|
|
||||||
**Released**
|
|
||||||
✅ Create Companies & People
|
|
||||||
✅ View, filter and sort Companies & People
|
|
||||||
✅ Comments
|
|
||||||
|
|
||||||
**In development**
|
|
||||||
⚙️ Pipelines
|
|
||||||
⚙️ Custom Fields
|
|
||||||
|
|
||||||
**Planned**
|
|
||||||
📅 Activity log
|
|
||||||
📅 Auto-logging emails
|
|
||||||
📅 Search / Cmd + K
|
|
||||||
📅 Data connectors
|
|
||||||
📅 +++
|
|
||||||
|
|
||||||
# Documentation
|
# Documentation
|
||||||
The doc is available on [docs.twenty.com](https://docs.twenty.com)
|
The doc is available on [docs.twenty.com](https://docs.twenty.com)
|
||||||
|
|
||||||
We don't have a Slack community yet but we will create one when we are ready to launch.
|
If you have any question feel free to ask on our [Discord](https://discord.com/invite/3Wneyvmn)
|
||||||
In the meantime, feel free to create a Github issue or open a discussion.
|
|
||||||
|
# Features
|
||||||
|
We are currently in the development phase of Twenty's alpha version. We are releasing new features on a biweekly basis. As mentionned above, do not hesitate to add issues if you need something specific, we'll do our best to ship it.
|
||||||
|
|
||||||
|
You can add, filter, sort, edit and track your customers in a table:
|
||||||
|
|
||||||
|
<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/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>
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
You can create one or several opportunities for each companies:
|
||||||
|
|
||||||
|
<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/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>
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
You can create some rich notes (and very soon tasks) that will be displayed in a timeline:
|
||||||
|
|
||||||
|
<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/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>
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
You can navigate quickly through the app using keyboard shortcuts and our integrated search:
|
||||||
|
|
||||||
|
<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/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>
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
# Next developments
|
||||||
|
|
||||||
|
⚙️ A task system<br>
|
||||||
|
⚙️ A notification center<br>
|
||||||
|
⚙️ More standard fields<br>
|
||||||
|
⚙️ Pipelines and table customization<br>
|
||||||
|
⚙️ A new dark mode with higher contrasts<br>
|
||||||
|
⚙️ A lot of bug fixes and other improvements<br>
|
||||||
|
|
||||||
|
Later this year we are considering releasing:
|
||||||
|
📅 Advanced search and filters<br>
|
||||||
|
📅 Auto-logging emails<br>
|
||||||
|
📅 Data connectors<br>
|
||||||
|
📅 Custom fields<br>
|
||||||
|
📅 +++<br>
|
||||||
|
|
||||||
|
Track the next features on [Github Projects](https://github.com/orgs/twentyhq/projects/1) and help us prioritising new ones by upvoting or adding [issues](https://github.com/twentyhq/twenty/issues)
|
||||||
|
|
||||||
|
|
||||||
# Office hours
|
# Office hours
|
||||||
Want to meet the team? Get direct support?
|
Want to meet the team? Get direct support?
|
||||||
@@ -72,6 +127,6 @@ Feel free to book a slot during our office hours
|
|||||||
<picture>
|
<picture>
|
||||||
<source media="(prefers-color-scheme: dark)" srcset="https://cal.com/book-with-cal-dark.svg">
|
<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">
|
<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="25">
|
<img alt="Book us with Cal.com" src="https://cal.com/book-with-cal-light.svg" height="40">
|
||||||
</picture>
|
</picture>
|
||||||
</a>
|
</a>
|
||||||
|
|||||||
BIN
docs/static/img/preview-light.png
vendored
BIN
docs/static/img/preview-light.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 596 KiB After Width: | Height: | Size: 596 KiB |
Reference in New Issue
Block a user