mirror of
https://github.com/twentyhq/twenty
synced 2026-04-21 21:47:38 +00:00
70a060b4ee
## Summary This PR fixes several small documentation issues in the contributor and setup guides: - fixes broken docs links in the root README - corrects multiple typos and capitalization issues in contributor docs - fixes malformed Markdown for the Redis command in local setup - improves wording in the Docker Compose self-hosting guide ## Changes - updated README installation links to the current docs routes - changed `Open-source` to `open-source` - fixed `specially` -> `especially` in the frontend style guide - normalized `MacOS` -> `macOS`, `powershell` -> `PowerShell`, and `Postgresql` -> `PostgreSQL` - replaced the invalid `localhost:5432` Markdown link with inline code - fixed the malformed fenced code block for `brew services start redis` - cleaned up Redis naming/capitalization and a few grammar issues in the setup docs - improved the warning and environment-variable wording in the Docker Compose guide ## Testing - not run; docs-only changes --------- Co-authored-by: Charles Bochet <charlesBochet@users.noreply.github.com>
136 lines
7.4 KiB
Markdown
136 lines
7.4 KiB
Markdown
<p align="center">
|
|
<a href="https://www.twenty.com">
|
|
<img src="./packages/twenty-website/public/images/core/logo.svg" width="100px" alt="Twenty logo" />
|
|
</a>
|
|
</p>
|
|
|
|
<h2 align="center" >The #1 Open-Source CRM </h2>
|
|
|
|
<p align="center"><a href="https://twenty.com">🌐 Website</a> · <a href="https://docs.twenty.com">📚 Documentation</a> · <a href="https://github.com/orgs/twentyhq/projects/1"><img src="./packages/twenty-website/public/images/readme/planner-icon.svg" width="12" height="12"/> Roadmap </a> · <a href="https://discord.gg/cx5n4Jzs57"><img src="./packages/twenty-website/public/images/readme/discord-icon.svg" width="12" height="12"/> Discord</a> · <a href="https://www.figma.com/file/xt8O9mFeLl46C5InWwoMrN/Twenty"><img src="./packages/twenty-website/public/images/readme/figma-icon.png" width="12" height="12"/> 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/refs/heads/main/packages/twenty-website/public/images/readme/github-cover-dark.png" />
|
|
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/main/packages/twenty-website/public/images/readme/github-cover-light.png" />
|
|
<img src="./packages/twenty-website/public/images/readme/github-cover-light.png" alt="Cover" />
|
|
</picture>
|
|
</a>
|
|
</p>
|
|
|
|
<br />
|
|
|
|
# Installation
|
|
|
|
See:
|
|
🚀 [Self-hosting](https://docs.twenty.com/developers/self-host/capabilities/docker-compose)
|
|
🖥️ [Local Setup](https://docs.twenty.com/developers/contribute/capabilities/local-setup)
|
|
|
|
# Why Twenty
|
|
|
|
We built Twenty for three reasons:
|
|
|
|
**CRMs are too expensive, and users are trapped.** Companies use locked-in customer data to hike prices. It shouldn't be that way.
|
|
|
|
**A fresh start is required to build a better experience.** We can learn from past mistakes and craft a cohesive experience inspired by new UX patterns from tools like Notion, Airtable or Linear.
|
|
|
|
**We believe in open-source and community.** Hundreds of developers are already building Twenty together. Once we have plugin capabilities, a whole ecosystem will grow around it.
|
|
|
|
<br />
|
|
|
|
# What You Can Do With Twenty
|
|
|
|
Please feel free to flag any specific needs you have by creating an issue.
|
|
|
|
Below are a few features we have implemented to date:
|
|
|
|
+ [Personalize layouts with filters, sort, group by, kanban and table views](#personalize-layouts-with-filters-sort-group-by-kanban-and-table-views)
|
|
+ [Customize your objects and fields](#customize-your-objects-and-fields)
|
|
+ [Create and manage permissions with custom roles](#create-and-manage-permissions-with-custom-roles)
|
|
+ [Automate workflow with triggers and actions](#automate-workflow-with-triggers-and-actions)
|
|
+ [Emails, calendar events, files, and more](#emails-calendar-events-files-and-more)
|
|
|
|
|
|
## Personalize layouts with filters, sort, group by, kanban and table views
|
|
|
|
<p align="center">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/main/packages/twenty-website/public/images/readme/views-dark.png" />
|
|
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/main/packages/twenty-website/public/images/readme/views-light.png" />
|
|
<img src="./packages/twenty-website/public/images/readme/views-light.png" alt="Companies Kanban Views" />
|
|
</picture>
|
|
</p>
|
|
|
|
## Customize your objects and fields
|
|
|
|
<p align="center">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/main/packages/twenty-website/public/images/readme/data-model-dark.png" />
|
|
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/main/packages/twenty-website/public/images/readme/data-model-light.png" />
|
|
<img src="./packages/twenty-website/public/images/readme/data-model-light.png" alt="Setting Custom Objects" />
|
|
</picture>
|
|
</p>
|
|
|
|
## Create and manage permissions with custom roles
|
|
|
|
<p align="center">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/main/packages/twenty-website/public/images/readme/permissions-dark.png" />
|
|
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/main/packages/twenty-website/public/images/readme/permissions-light.png" />
|
|
<img src="./packages/twenty-website/public/images/readme/permissions-light.png" alt="Permissions" />
|
|
</picture>
|
|
</p>
|
|
|
|
## Automate workflow with triggers and actions
|
|
|
|
<p align="center">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/main/packages/twenty-website/public/images/readme/workflows-dark.png" />
|
|
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/main/packages/twenty-website/public/images/readme/workflows-light.png" />
|
|
<img src="./packages/twenty-website/public/images/readme/workflows-light.png" alt="Workflows" />
|
|
</picture>
|
|
</p>
|
|
|
|
## Emails, calendar events, files, and more
|
|
|
|
<p align="center">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/main/packages/twenty-website/public/images/readme/plus-other-features-dark.png" />
|
|
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/main/packages/twenty-website/public/images/readme/plus-other-features-light.png" />
|
|
<img src="./packages/twenty-website/public/images/readme/plus-other-features-light.png" alt="Other Features" />
|
|
</picture>
|
|
</p>
|
|
|
|
<br />
|
|
|
|
# Stack
|
|
- [TypeScript](https://www.typescriptlang.org/)
|
|
- [Nx](https://nx.dev/)
|
|
- [NestJS](https://nestjs.com/), with [BullMQ](https://bullmq.io/), [PostgreSQL](https://www.postgresql.org/), [Redis](https://redis.io/)
|
|
- [React](https://reactjs.org/), with [Jotai](https://jotai.org/), [Linaria](https://linaria.dev/) and [Lingui](https://lingui.dev/)
|
|
|
|
|
|
|
|
# Thanks
|
|
|
|
<p align="center">
|
|
<a href="https://www.chromatic.com/"><img src="./packages/twenty-website/public/images/readme/chromatic.png" height="30" alt="Chromatic" /></a>
|
|
<a href="https://greptile.com"><img src="./packages/twenty-website/public/images/readme/greptile.png" height="30" alt="Greptile" /></a>
|
|
<a href="https://sentry.io/"><img src="./packages/twenty-website/public/images/readme/sentry.png" height="30" alt="Sentry" /></a>
|
|
<a href="https://crowdin.com/"><img src="./packages/twenty-website/public/images/readme/crowdin.png" height="30" alt="Crowdin" /></a>
|
|
<a href="https://e2b.dev/"><img src="./packages/twenty-website/public/images/readme/e2b.svg" height="30" alt="E2B" /></a>
|
|
</p>
|
|
|
|
Thanks to these amazing services that we use and recommend for UI testing (Chromatic), code review (Greptile), catching bugs (Sentry) and translating (Crowdin).
|
|
|
|
|
|
# Join the Community
|
|
|
|
- Star the repo
|
|
- Subscribe to releases (watch -> custom -> releases)
|
|
- Follow us on [Twitter](https://twitter.com/twentycrm) or [LinkedIn](https://www.linkedin.com/company/twenty/)
|
|
- Join our [Discord](https://discord.gg/cx5n4Jzs57)
|
|
- Improve translations on [Crowdin](https://twenty.crowdin.com/twenty)
|
|
- [Contributions](https://github.com/twentyhq/twenty/contribute) are, of course, most welcome!
|