Elgato_dark/twenty
1
0
Fork 0
mirror of https://github.com/twentyhq/twenty synced 2026-04-21 21:47:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 18
twenty/README.md

137 lines
7.4 KiB
Markdown
Raw Normal View History

Readme visual update (#146) * new header for Readme * new header for Readme * new header for Readme * Correct naming and changed assets * Applied Strapi method for dark-mode images * Corrected logo-square-dark look * Corrected a typo * Corrected spacing
2023-05-27 06:39:26 +00:00
<p align="center">
Add cal.com office hours (#488) Add office hours
2023-07-01 00:14:43 +00:00
<a href="https://www.twenty.com">
Temporary fix README (#5814) Emergency fix for broken readme images
2024-06-11 08:18:08 +00:00
<img src="./packages/twenty-website/public/images/core/logo.svg" width="100px" alt="Twenty logo" />
Readme visual update (#146) * new header for Readme * new header for Readme * new header for Readme * Correct naming and changed assets * Applied Strapi method for dark-mode images * Corrected logo-square-dark look * Corrected a typo * Corrected spacing
2023-05-27 06:39:26 +00:00
</a>
</p>
Update readme with partner logos (#11722) Recognize the role of Greptile/Sentry/Crowdin/Chromatic which give generous open source plans + some cleanup
2025-04-24 14:09:43 +00:00
<h2 align="center" >The #1 Open-Source CRM </h2>
Readme visual update (#146) * new header for Readme * new header for Readme * new header for Readme * Correct naming and changed assets * Applied Strapi method for dark-mode images * Corrected logo-square-dark look * Corrected a typo * Corrected spacing
2023-05-27 06:39:26 +00:00
Migrate documentation to Mintlify and configure 301 redirects (#15502) ## Summary Completes the migration of all documentation from twenty-website to a new Mintlify-powered documentation site at docs.twenty.com. ## Changes Made ### New Package: `twenty-docs` - ✅ Created new Mintlify documentation package - ✅ Migrated 95 content pages (user-guide, developers, twenty-ui) - ✅ Migrated 81 images - ✅ Converted all custom components to Mintlify native components - ✅ Configured navigation with 2 tabs and 94 pages - ✅ Added Helper AI Agent with searchArticles tool for docs search ### Updated: `twenty-website` - ✅ Added 11 redirect rules (301 permanent) in next.config.js - ✅ Removed all documentation content (111 files) - ✅ Removed documentation routes (user-guide, developers, twenty-ui) - ✅ Removed documentation components (9 files) - ✅ Updated keystatic.config.ts - ✅ Preserved all marketing/release pages ### Updated: Core Files - ✅ Updated README.md - docs links point to docs.twenty.com - ✅ Updated CONTRIBUTING.md - code quality link updated - ✅ Updated SupportDropdown.tsx - user guide link updated - ✅ Updated Footer.tsx - user guide link updated
2025-10-31 16:44:14 +00:00
<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>
Readme visual update (#146) * new header for Readme * new header for Readme * new header for Readme * Correct naming and changed assets * Applied Strapi method for dark-mode images * Corrected logo-square-dark look * Corrected a typo * Corrected spacing
2023-05-27 06:39:26 +00:00
<br />
Update README and Documentation (#1875) * Added Overview page * Revised Getting Started page * Minor revision * Edited readme, minor modifications to docs * Removed sweep.yaml, .devcontainer, .ergomake * Moved security.md to .github, added contributing.md * changes as per code review
2023-10-07 09:24:44 +00:00
Readme visual update (#146) * new header for Readme * new header for Readme * new header for Readme * Correct naming and changed assets * Applied Strapi method for dark-mode images * Corrected logo-square-dark look * Corrected a typo * Corrected spacing
2023-05-27 06:39:26 +00:00
<p align="center">
Add cal.com office hours (#488) Add office hours
2023-07-01 00:14:43 +00:00
<a href="https://www.twenty.com">
<picture>
fixing images url to main branch (#12862) Simple fix for the readme on github
2025-06-25 08:47:39 +00:00
<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" />
change log, user guide, and readme updates for v1 launch (#12860) ### Summary - Minor updates to the user guide with clarification on product functionality as per user confusion - Updates to existing documentation about past features to reflect current functionality (favorites, side panel controls, etc) - Updated README with product hunt banner and new features for v1 release --------- Co-authored-by: Vicky Wang <vw92@cornell.edu>
2025-06-25 08:19:04 +00:00
<img src="./packages/twenty-website/public/images/readme/github-cover-light.png" alt="Cover" />
Add cal.com office hours (#488) Add office hours
2023-07-01 00:14:43 +00:00
</picture>
Readme visual update (#146) * new header for Readme * new header for Readme * new header for Readme * Correct naming and changed assets * Applied Strapi method for dark-mode images * Corrected logo-square-dark look * Corrected a typo * Corrected spacing
2023-05-27 06:39:26 +00:00
</a>
</p>
Update README and Documentation (#1875) * Added Overview page * Revised Getting Started page * Minor revision * Edited readme, minor modifications to docs * Removed sweep.yaml, .devcontainer, .ergomake * Moved security.md to .github, added contributing.md * changes as per code review
2023-10-07 09:24:44 +00:00
Update readme with partner logos (#11722) Recognize the role of Greptile/Sentry/Crowdin/Chromatic which give generous open source plans + some cleanup
2025-04-24 14:09:43 +00:00
<br />
Update README and Documentation (#1875) * Added Overview page * Revised Getting Started page * Minor revision * Edited readme, minor modifications to docs * Removed sweep.yaml, .devcontainer, .ergomake * Moved security.md to .github, added contributing.md * changes as per code review
2023-10-07 09:24:44 +00:00
Migrate documentation to Mintlify and configure 301 redirects (#15502) ## Summary Completes the migration of all documentation from twenty-website to a new Mintlify-powered documentation site at docs.twenty.com. ## Changes Made ### New Package: `twenty-docs` - ✅ Created new Mintlify documentation package - ✅ Migrated 95 content pages (user-guide, developers, twenty-ui) - ✅ Migrated 81 images - ✅ Converted all custom components to Mintlify native components - ✅ Configured navigation with 2 tabs and 94 pages - ✅ Added Helper AI Agent with searchArticles tool for docs search ### Updated: `twenty-website` - ✅ Added 11 redirect rules (301 permanent) in next.config.js - ✅ Removed all documentation content (111 files) - ✅ Removed documentation routes (user-guide, developers, twenty-ui) - ✅ Removed documentation components (9 files) - ✅ Updated keystatic.config.ts - ✅ Preserved all marketing/release pages ### Updated: Core Files - ✅ Updated README.md - docs links point to docs.twenty.com - ✅ Updated CONTRIBUTING.md - code quality link updated - ✅ Updated SupportDropdown.tsx - user guide link updated - ✅ Updated Footer.tsx - user guide link updated
2025-10-31 16:44:14 +00:00
# Installation
Pass Billing Checkout var in url to bypass credit card (#9283)
2024-12-31 13:48:00 +00:00
Migrate documentation to Mintlify and configure 301 redirects (#15502) ## Summary Completes the migration of all documentation from twenty-website to a new Mintlify-powered documentation site at docs.twenty.com. ## Changes Made ### New Package: `twenty-docs` - ✅ Created new Mintlify documentation package - ✅ Migrated 95 content pages (user-guide, developers, twenty-ui) - ✅ Migrated 81 images - ✅ Converted all custom components to Mintlify native components - ✅ Configured navigation with 2 tabs and 94 pages - ✅ Added Helper AI Agent with searchArticles tool for docs search ### Updated: `twenty-website` - ✅ Added 11 redirect rules (301 permanent) in next.config.js - ✅ Removed all documentation content (111 files) - ✅ Removed documentation routes (user-guide, developers, twenty-ui) - ✅ Removed documentation components (9 files) - ✅ Updated keystatic.config.ts - ✅ Preserved all marketing/release pages ### Updated: Core Files - ✅ Updated README.md - docs links point to docs.twenty.com - ✅ Updated CONTRIBUTING.md - code quality link updated - ✅ Updated SupportDropdown.tsx - user guide link updated - ✅ Updated Footer.tsx - user guide link updated
2025-10-31 16:44:14 +00:00
See:
docs: fix contributor docs links and typos (#18637) ## 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>
2026-03-14 11:54:31 +00:00
🚀 [Self-hosting](https://docs.twenty.com/developers/self-host/capabilities/docker-compose)
🖥️ [Local Setup](https://docs.twenty.com/developers/contribute/capabilities/local-setup)
Readme visual update (#146) * new header for Readme * new header for Readme * new header for Readme * Correct naming and changed assets * Applied Strapi method for dark-mode images * Corrected logo-square-dark look * Corrected a typo * Corrected spacing
2023-05-27 06:39:26 +00:00
Update README: add E2B logo and improve heading (#18144) ## Summary - Add E2B logo to the Thanks section (after Crowdin, same height) - Rename section heading from "Does the world need another CRM?" to "Why Twenty" for a more confident, direct tone ## Test plan - [ ] Verify E2B logo renders correctly on GitHub README - [ ] Confirm all other logos still display properly Made with [Cursor](https://cursor.com) Co-authored-by: Cursor <cursoragent@cursor.com>
2026-02-21 14:02:11 +00:00
# Why Twenty
Setup Nest and React projects
2022-12-01 14:58:08 +00:00
Update README (#9351) Needed a new description
2025-01-05 13:11:19 +00:00
We built Twenty for three reasons:
Improve documentation (#349) * Improve documentation content * Improve documentation style
2023-06-21 23:23:31 +00:00
Update README (#9351) Needed a new description
2025-01-05 13:11:19 +00:00
**CRMs are too expensive, and users are trapped.** Companies use locked-in customer data to hike prices. It shouldn't be that way.
Improve documentation (#349) * Improve documentation content * Improve documentation style
2023-06-21 23:23:31 +00:00
Update README (#9351) Needed a new description
2025-01-05 13:11:19 +00:00
**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.
doc: Update README.md with suggestions (#773) Update README.md with suggestions I changed some minor stuff for readability.
2023-07-20 06:34:19 +00:00
docs: fix contributor docs links and typos (#18637) ## 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>
2026-03-14 11:54:31 +00:00
**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.
Added Progress section into Readme (#153)
2023-05-29 11:59:45 +00:00
Update readme with partner logos (#11722) Recognize the role of Greptile/Sentry/Crowdin/Chromatic which give generous open source plans + some cleanup
2025-04-24 14:09:43 +00:00
<br />
Added Progress section into Readme (#153)
2023-05-29 11:59:45 +00:00
Update README and Documentation (#1875) * Added Overview page * Revised Getting Started page * Minor revision * Edited readme, minor modifications to docs * Removed sweep.yaml, .devcontainer, .ergomake * Moved security.md to .github, added contributing.md * changes as per code review
2023-10-07 09:24:44 +00:00
# What You Can Do With Twenty
Migrate documentation to Mintlify and configure 301 redirects (#15502) ## Summary Completes the migration of all documentation from twenty-website to a new Mintlify-powered documentation site at docs.twenty.com. ## Changes Made ### New Package: `twenty-docs` - ✅ Created new Mintlify documentation package - ✅ Migrated 95 content pages (user-guide, developers, twenty-ui) - ✅ Migrated 81 images - ✅ Converted all custom components to Mintlify native components - ✅ Configured navigation with 2 tabs and 94 pages - ✅ Added Helper AI Agent with searchArticles tool for docs search ### Updated: `twenty-website` - ✅ Added 11 redirect rules (301 permanent) in next.config.js - ✅ Removed all documentation content (111 files) - ✅ Removed documentation routes (user-guide, developers, twenty-ui) - ✅ Removed documentation components (9 files) - ✅ Updated keystatic.config.ts - ✅ Preserved all marketing/release pages ### Updated: Core Files - ✅ Updated README.md - docs links point to docs.twenty.com - ✅ Updated CONTRIBUTING.md - code quality link updated - ✅ Updated SupportDropdown.tsx - user guide link updated - ✅ Updated Footer.tsx - user guide link updated
2025-10-31 16:44:14 +00:00
Please feel free to flag any specific needs you have by creating an issue.
README update (#749) * README update * Fix linter
2023-07-19 09:50:07 +00:00
Update README (#9351) Needed a new description
2025-01-05 13:11:19 +00:00
Below are a few features we have implemented to date:
doc: Update README.md with quick links in the Features section (#1994) Added quick links in the Features section
2023-10-13 09:37:34 +00:00
change log, user guide, and readme updates for v1 launch (#12860) ### Summary - Minor updates to the user guide with clarification on product functionality as per user confusion - Updates to existing documentation about past features to reflect current functionality (favorites, side panel controls, etc) - Updated README with product hunt banner and new features for v1 release --------- Co-authored-by: Vicky Wang <vw92@cornell.edu>
2025-06-25 08:19:04 +00:00
+ [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)
Added Progress section into Readme (#153)
2023-05-29 11:59:45 +00:00
add contibuting_example.md (#6998) add a contributing_example.md on folder .github --------- Co-authored-by: Félix Malfait <felix@twenty.com>
2024-09-12 10:31:34 +00:00
change log, user guide, and readme updates for v1 launch (#12860) ### Summary - Minor updates to the user guide with clarification on product functionality as per user confusion - Updates to existing documentation about past features to reflect current functionality (favorites, side panel controls, etc) - Updated README with product hunt banner and new features for v1 release --------- Co-authored-by: Vicky Wang <vw92@cornell.edu>
2025-06-25 08:19:04 +00:00
## Personalize layouts with filters, sort, group by, kanban and table views
docs: lint readme
2023-04-18 13:37:05 +00:00
Updated the Read.me for the HN release (#737) * Update README.md --------- Co-authored-by: Charles Bochet <charles@twenty.com>
2023-07-18 18:22:39 +00:00
<p align="center">
<picture>
fixing images url to main branch (#12862) Simple fix for the readme on github
2025-06-25 08:47:39 +00:00
<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" />
change log, user guide, and readme updates for v1 launch (#12860) ### Summary - Minor updates to the user guide with clarification on product functionality as per user confusion - Updates to existing documentation about past features to reflect current functionality (favorites, side panel controls, etc) - Updated README with product hunt banner and new features for v1 release --------- Co-authored-by: Vicky Wang <vw92@cornell.edu>
2025-06-25 08:19:04 +00:00
<img src="./packages/twenty-website/public/images/readme/views-light.png" alt="Companies Kanban Views" />
Updated the Read.me for the HN release (#737) * Update README.md --------- Co-authored-by: Charles Bochet <charles@twenty.com>
2023-07-18 18:22:39 +00:00
</picture>
</p>
change log, user guide, and readme updates for v1 launch (#12860) ### Summary - Minor updates to the user guide with clarification on product functionality as per user confusion - Updates to existing documentation about past features to reflect current functionality (favorites, side panel controls, etc) - Updated README with product hunt banner and new features for v1 release --------- Co-authored-by: Vicky Wang <vw92@cornell.edu>
2025-06-25 08:19:04 +00:00
## Customize your objects and fields
Updated the Read.me for the HN release (#737) * Update README.md --------- Co-authored-by: Charles Bochet <charles@twenty.com>
2023-07-18 18:22:39 +00:00
<p align="center">
<picture>
fixing images url to main branch (#12862) Simple fix for the readme on github
2025-06-25 08:47:39 +00:00
<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" />
change log, user guide, and readme updates for v1 launch (#12860) ### Summary - Minor updates to the user guide with clarification on product functionality as per user confusion - Updates to existing documentation about past features to reflect current functionality (favorites, side panel controls, etc) - Updated README with product hunt banner and new features for v1 release --------- Co-authored-by: Vicky Wang <vw92@cornell.edu>
2025-06-25 08:19:04 +00:00
<img src="./packages/twenty-website/public/images/readme/data-model-light.png" alt="Setting Custom Objects" />
Updated the Read.me for the HN release (#737) * Update README.md --------- Co-authored-by: Charles Bochet <charles@twenty.com>
2023-07-18 18:22:39 +00:00
</picture>
</p>
change log, user guide, and readme updates for v1 launch (#12860) ### Summary - Minor updates to the user guide with clarification on product functionality as per user confusion - Updates to existing documentation about past features to reflect current functionality (favorites, side panel controls, etc) - Updated README with product hunt banner and new features for v1 release --------- Co-authored-by: Vicky Wang <vw92@cornell.edu>
2025-06-25 08:19:04 +00:00
## Create and manage permissions with custom roles
Updated the Read.me for the HN release (#737) * Update README.md --------- Co-authored-by: Charles Bochet <charles@twenty.com>
2023-07-18 18:22:39 +00:00
<p align="center">
<picture>
fixing images url to main branch (#12862) Simple fix for the readme on github
2025-06-25 08:47:39 +00:00
<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" />
change log, user guide, and readme updates for v1 launch (#12860) ### Summary - Minor updates to the user guide with clarification on product functionality as per user confusion - Updates to existing documentation about past features to reflect current functionality (favorites, side panel controls, etc) - Updated README with product hunt banner and new features for v1 release --------- Co-authored-by: Vicky Wang <vw92@cornell.edu>
2025-06-25 08:19:04 +00:00
<img src="./packages/twenty-website/public/images/readme/permissions-light.png" alt="Permissions" />
Update of the readme with updated visuals (#4041) * README udpated illustrations & taglines * Delete packages/twenty-docs/static/img/create-tasks-dark.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/create-tasks-light.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/follow-your-deals-dark.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/follow-your-deals-light.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/rich-notes-dark.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/rich-notes-light.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/shortcut-navigation-dark.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/shortcut-navigation-light.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/visualise-customer-dark.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/visualise-customer-light.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/logo-square-light.svg Logo not part of the visual identity * Updated a typo
2024-02-19 10:40:26 +00:00
</picture>
</p>
change log, user guide, and readme updates for v1 launch (#12860) ### Summary - Minor updates to the user guide with clarification on product functionality as per user confusion - Updates to existing documentation about past features to reflect current functionality (favorites, side panel controls, etc) - Updated README with product hunt banner and new features for v1 release --------- Co-authored-by: Vicky Wang <vw92@cornell.edu>
2025-06-25 08:19:04 +00:00
## Automate workflow with triggers and actions
Update of the readme with updated visuals (#4041) * README udpated illustrations & taglines * Delete packages/twenty-docs/static/img/create-tasks-dark.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/create-tasks-light.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/follow-your-deals-dark.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/follow-your-deals-light.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/rich-notes-dark.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/rich-notes-light.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/shortcut-navigation-dark.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/shortcut-navigation-light.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/visualise-customer-dark.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/visualise-customer-light.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/logo-square-light.svg Logo not part of the visual identity * Updated a typo
2024-02-19 10:40:26 +00:00
<p align="center">
<picture>
fixing images url to main branch (#12862) Simple fix for the readme on github
2025-06-25 08:47:39 +00:00
<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" />
change log, user guide, and readme updates for v1 launch (#12860) ### Summary - Minor updates to the user guide with clarification on product functionality as per user confusion - Updates to existing documentation about past features to reflect current functionality (favorites, side panel controls, etc) - Updated README with product hunt banner and new features for v1 release --------- Co-authored-by: Vicky Wang <vw92@cornell.edu>
2025-06-25 08:19:04 +00:00
<img src="./packages/twenty-website/public/images/readme/workflows-light.png" alt="Workflows" />
Update of the readme with updated visuals (#4041) * README udpated illustrations & taglines * Delete packages/twenty-docs/static/img/create-tasks-dark.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/create-tasks-light.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/follow-your-deals-dark.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/follow-your-deals-light.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/rich-notes-dark.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/rich-notes-light.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/shortcut-navigation-dark.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/shortcut-navigation-light.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/visualise-customer-dark.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/visualise-customer-light.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/logo-square-light.svg Logo not part of the visual identity * Updated a typo
2024-02-19 10:40:26 +00:00
</picture>
</p>
change log, user guide, and readme updates for v1 launch (#12860) ### Summary - Minor updates to the user guide with clarification on product functionality as per user confusion - Updates to existing documentation about past features to reflect current functionality (favorites, side panel controls, etc) - Updated README with product hunt banner and new features for v1 release --------- Co-authored-by: Vicky Wang <vw92@cornell.edu>
2025-06-25 08:19:04 +00:00
## Emails, calendar events, files, and more
Update of the readme with updated visuals (#4041) * README udpated illustrations & taglines * Delete packages/twenty-docs/static/img/create-tasks-dark.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/create-tasks-light.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/follow-your-deals-dark.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/follow-your-deals-light.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/rich-notes-dark.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/rich-notes-light.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/shortcut-navigation-dark.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/shortcut-navigation-light.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/visualise-customer-dark.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/visualise-customer-light.png Deleting depreciated illustration * Delete packages/twenty-docs/static/img/logo-square-light.svg Logo not part of the visual identity * Updated a typo
2024-02-19 10:40:26 +00:00
<p align="center">
<picture>
fixing images url to main branch (#12862) Simple fix for the readme on github
2025-06-25 08:47:39 +00:00
<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" />
change log, user guide, and readme updates for v1 launch (#12860) ### Summary - Minor updates to the user guide with clarification on product functionality as per user confusion - Updates to existing documentation about past features to reflect current functionality (favorites, side panel controls, etc) - Updated README with product hunt banner and new features for v1 release --------- Co-authored-by: Vicky Wang <vw92@cornell.edu>
2025-06-25 08:19:04 +00:00
<img src="./packages/twenty-website/public/images/readme/plus-other-features-light.png" alt="Other Features" />
Updated the Read.me for the HN release (#737) * Update README.md --------- Co-authored-by: Charles Bochet <charles@twenty.com>
2023-07-18 18:22:39 +00:00
</picture>
</p>
Update readme with partner logos (#11722) Recognize the role of Greptile/Sentry/Crowdin/Chromatic which give generous open source plans + some cleanup
2025-04-24 14:09:43 +00:00
<br />
Updated the Read.me for the HN release (#737) * Update README.md --------- Co-authored-by: Charles Bochet <charles@twenty.com>
2023-07-18 18:22:39 +00:00
Update README (#9351) Needed a new description
2025-01-05 13:11:19 +00:00
# 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/)
Complete linaria migration (#18361) ## Summary Completes the migration of the frontend styling system from **Emotion** (`@emotion/styled`, `@emotion/react`) to **Linaria** (`@linaria/react`, `@linaria/core`), a zero-runtime CSS-in-JS library where styles are extracted at build time. This is the final step of the migration — all ~494 files across `twenty-front`, `twenty-ui`, `twenty-website`, and `twenty-sdk` are now fully converted. ## Changes ### Styling Migration (across ~480 component files) - Replaced all `@emotion/styled` imports with `@linaria/react` - Converted runtime theme access patterns (`({ theme }) => theme.x.y`) to build-time `themeCssVariables` CSS custom properties - Replaced `useTheme()` hook (from Emotion) with `useContext(ThemeContext)` where runtime theme values are still needed (e.g., passing colors to non-CSS props like icon components) - Removed `@emotion/react` `css` helper usages in favor of Linaria template literals ### Dependency & Configuration Changes - **Removed**: `@emotion/react`, `@emotion/styled` from root `package.json` - **Added**: `@wyw-in-js/babel-preset`, `next-with-linaria` (for twenty-website SSR support) - Updated Nx generator defaults from `@emotion/styled` to `@linaria/react` in `nx.json` - Simplified `vite.config.ts` (removed Emotion-specific configuration) - Updated `twenty-website/next.config.js` to use `next-with-linaria` for SSR Linaria support ### Storybook & Testing - Removed `ThemeProvider` from Emotion in Storybook previews (`twenty-front`, `twenty-sdk`) - Now relies solely on `ThemeContextProvider` for theme injection ### Documentation - Removed the temporary `docs/emotion-to-linaria-migration-plan.md` (migration complete) - Updated `CLAUDE.md` and `README.md` to reflect Linaria as the styling stack - Updated frontend style guide docs across all locales ## How it works Linaria extracts styles at build time via the `@wyw-in-js/vite` plugin. All expressions in `styled` template literals must be **statically evaluable** — no runtime theme objects or closures over component state. - **Static styles** use `themeCssVariables` which map to CSS custom properties (`var(--theme-color-x)`) - **Runtime theme access** (for non-CSS use cases like icon `color` props) uses `useContext(ThemeContext)` instead of Emotion's `useTheme()`
2026-03-03 23:50:06 +00:00
- [React](https://reactjs.org/), with [Jotai](https://jotai.org/), [Linaria](https://linaria.dev/) and [Lingui](https://lingui.dev/)
Update readme with partner logos (#11722) Recognize the role of Greptile/Sentry/Crowdin/Chromatic which give generous open source plans + some cleanup
2025-04-24 14:09:43 +00:00
# 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>
Update README: add E2B logo and improve heading (#18144) ## Summary - Add E2B logo to the Thanks section (after Crowdin, same height) - Rename section heading from "Does the world need another CRM?" to "Why Twenty" for a more confident, direct tone ## Test plan - [ ] Verify E2B logo renders correctly on GitHub README - [ ] Confirm all other logos still display properly Made with [Cursor](https://cursor.com) Co-authored-by: Cursor <cursoragent@cursor.com>
2026-02-21 14:02:11 +00:00
<a href="https://e2b.dev/"><img src="./packages/twenty-website/public/images/readme/e2b.svg" height="30" alt="E2B" /></a>
Update readme with partner logos (#11722) Recognize the role of Greptile/Sentry/Crowdin/Chromatic which give generous open source plans + some cleanup
2025-04-24 14:09:43 +00:00
</p>
Thanks to these amazing services that we use and recommend for UI testing (Chromatic), code review (Greptile), catching bugs (Sentry) and translating (Crowdin).
README update (#749) * README update * Fix linter
2023-07-19 09:50:07 +00:00
Readme update with demo (#3042)
2023-12-17 15:26:54 +00:00
# Join the Community
Update README and Documentation (#1875) * Added Overview page * Revised Getting Started page * Minor revision * Edited readme, minor modifications to docs * Removed sweep.yaml, .devcontainer, .ergomake * Moved security.md to .github, added contributing.md * changes as per code review
2023-10-07 09:24:44 +00:00
- Star the repo
Update README (#9351) Needed a new description
2025-01-05 13:11:19 +00:00
- Subscribe to releases (watch -> custom -> releases)
Migrate documentation to Mintlify and configure 301 redirects (#15502) ## Summary Completes the migration of all documentation from twenty-website to a new Mintlify-powered documentation site at docs.twenty.com. ## Changes Made ### New Package: `twenty-docs` - ✅ Created new Mintlify documentation package - ✅ Migrated 95 content pages (user-guide, developers, twenty-ui) - ✅ Migrated 81 images - ✅ Converted all custom components to Mintlify native components - ✅ Configured navigation with 2 tabs and 94 pages - ✅ Added Helper AI Agent with searchArticles tool for docs search ### Updated: `twenty-website` - ✅ Added 11 redirect rules (301 permanent) in next.config.js - ✅ Removed all documentation content (111 files) - ✅ Removed documentation routes (user-guide, developers, twenty-ui) - ✅ Removed documentation components (9 files) - ✅ Updated keystatic.config.ts - ✅ Preserved all marketing/release pages ### Updated: Core Files - ✅ Updated README.md - docs links point to docs.twenty.com - ✅ Updated CONTRIBUTING.md - code quality link updated - ✅ Updated SupportDropdown.tsx - user guide link updated - ✅ Updated Footer.tsx - user guide link updated
2025-10-31 16:44:14 +00:00
- Follow us on [Twitter](https://twitter.com/twentycrm) or [LinkedIn](https://www.linkedin.com/company/twenty/)
Readme update with demo (#3042)
2023-12-17 15:26:54 +00:00
- Join our [Discord](https://discord.gg/cx5n4Jzs57)
Migrate documentation to Mintlify and configure 301 redirects (#15502) ## Summary Completes the migration of all documentation from twenty-website to a new Mintlify-powered documentation site at docs.twenty.com. ## Changes Made ### New Package: `twenty-docs` - ✅ Created new Mintlify documentation package - ✅ Migrated 95 content pages (user-guide, developers, twenty-ui) - ✅ Migrated 81 images - ✅ Converted all custom components to Mintlify native components - ✅ Configured navigation with 2 tabs and 94 pages - ✅ Added Helper AI Agent with searchArticles tool for docs search ### Updated: `twenty-website` - ✅ Added 11 redirect rules (301 permanent) in next.config.js - ✅ Removed all documentation content (111 files) - ✅ Removed documentation routes (user-guide, developers, twenty-ui) - ✅ Removed documentation components (9 files) - ✅ Updated keystatic.config.ts - ✅ Preserved all marketing/release pages ### Updated: Core Files - ✅ Updated README.md - docs links point to docs.twenty.com - ✅ Updated CONTRIBUTING.md - code quality link updated - ✅ Updated SupportDropdown.tsx - user guide link updated - ✅ Updated Footer.tsx - user guide link updated
2025-10-31 16:44:14 +00:00
- Improve translations on [Crowdin](https://twenty.crowdin.com/twenty)
- [Contributions](https://github.com/twentyhq/twenty/contribute) are, of course, most welcome!
Reference in a new issue Copy permalink