README update (#749)

* README update

* Fix linter
This commit is contained in:
Félix Malfait 2023-07-19 11:50:07 +02:00 committed by GitHub
parent c2fb8fd040
commit 8af88d1ab3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 47 additions and 46 deletions

View File

@ -1,16 +1,15 @@
</br> <br>
<p align="center"> <p align="center">
<a href="https://www.twenty.com"> <a href="https://www.twenty.com">
<img src="./docs/static/img/logo-square-dark.svg" width="100px" alt="Twenty logo" /> <img src="./docs/static/img/logo-square-dark.svg" width="100px" alt="Twenty logo" />
</a> </a>
</p> </p>
<h2 align="center" >A modern CRM Alternative</h3> <h2 align="center" >A Modern Open Source CRM </h3>
<p align="center">Engineer-Designed. Business-Ready. <p align="center">Crafted with Engineer-Precision. Built for Business-Success.</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> · <a href="https://discord.gg/cx5n4Jzs57">Discord</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">
@ -23,105 +22,109 @@
</a> </a>
</p> </p>
# About
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.
**For our users:**
- 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
- 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](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
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. You can access and use the alpha version on [app.twenty.com](https://app.twenty.com).
Soon, we will 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. For a local setup, please check [the documentation](https://docs.twenty.com/start/local-setup).
It's a straightforward process that should have you up and running in minutes.
# Documentation # About
The doc is available on [docs.twenty.com](https://docs.twenty.com) We are building an Open Source CRM designed to be: enjoyable to use, easily extendable, and perfectly in-sync with your data.
Why go open source when the majority of CRMs are not?
**For day-to-day users:**
- A commitment to being completely open about what we're building, enabling them to peek under the hood and see the intricate machinery at work.
- An opportunity to be a decisive actor with a very short feedback loop and an the ability to shape the roadmap
**For the developer community:**
- A CRM that ban self-hosted for free, on your own network and close to your data sources
- A set of reusuable components such as tables or kanban boards (coming soon)
- A new way to think about CRM extensibility, one that can be owned by the engineering team and not external constultants (coming soon)
If you have any question feel free to ask on our [Discord](https://discord.com/invite/3Wneyvmn)
# Features # 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. We are currently in the development phase of Twenty's alpha version.
Don't hesitate to flag a specific need by creating an issue.
You can add, filter, sort, edit and track your customers in a table: Below are the features we have implemented to date.
You can add, filter, sort, edit and track your customers:
<p align="center"> <p align="center">
<a href="https://www.twenty.com">
<picture> <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: 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"> <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" /> <img src="./docs/static/img/preview-light.png" alt="Companies view" />
</picture> </picture>
</a>
</p> </p>
You can create one or several opportunities for each companies: You can create one or several opportunities for each company:
<p align="center"> <p align="center">
<a href="https://www.twenty.com">
<picture> <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: 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"> <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" /> <img src="./docs/static/img/preview-light.png" alt="Companies view" />
</picture> </picture>
</a>
</p> </p>
You can create some rich notes (and very soon tasks) that will be displayed in a timeline: You can create rich notes (and soon tasks) that are displayed in a timeline:
<p align="center"> <p align="center">
<a href="https://www.twenty.com">
<picture> <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: 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"> <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" /> <img src="./docs/static/img/preview-light.png" alt="Companies view" />
</picture> </picture>
</a>
</p> </p>
You can navigate quickly through the app using keyboard shortcuts and our integrated search: You can navigate quickly through the app using keyboard shortcuts and search:
<p align="center"> <p align="center">
<a href="https://www.twenty.com">
<picture> <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: 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"> <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" /> <img src="./docs/static/img/preview-light.png" alt="Companies view" />
</picture> </picture>
</a>
</p> </p>
# Next developments # Upcoming features
Coming before August 15:
⚙️  A task system<br> ⚙️  A task system<br>
⚙️  A notification center<br> ⚙️  A notification center<br>
⚙️  More standard fields<br> ⚙️  More standard fields<br>
⚙️  AI/LLM integration to Notes<br>
⚙️  Pipelines and table customization<br> ⚙️  Pipelines and table customization<br>
⚙️  A new dark mode with higher contrasts<br> ⚙️  A new dark mode with higher contrasts<br>
⚙️  A lot of bug fixes and other improvements<br> ⚙️  A lot of bug fixes and other improvements<br>
Later this year we are considering releasing: Coming later this year:
📅 Advanced search and filters<br> 📅 Advanced search and filters<br>
📅  Auto-logging emails<br> 📅  Auto-logging emails<br>
📅 Data connectors<br> 📅 Data connectors<br>
📅 Custom fields<br> 📅 Custom fields<br>
📅 Custom objects<br>
📅 +++<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) 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 # Office hours
Want to meet the team? Get direct support? Want to meet the team? Get direct support?
Feel free to book a slot during our office hours Feel free to book a slot during our office hours.
<a href="https://cal.com/team/twenty?utm_source=banner&utm_campaign=oss"> <a href="https://cal.com/team/twenty?utm_source=banner&utm_campaign=oss">
<picture> <picture>

View File

@ -1,4 +1,4 @@
import { useLocation, useParams } from 'react-router-dom'; import { useParams } from 'react-router-dom';
import { useTheme } from '@emotion/react'; import { useTheme } from '@emotion/react';
import { Timeline } from '@/activities/timeline/components/Timeline'; import { Timeline } from '@/activities/timeline/components/Timeline';
@ -14,8 +14,6 @@ import { CommentableType } from '~/generated/graphql';
export function PersonShow() { export function PersonShow() {
const personId = useParams().personId ?? ''; const personId = useParams().personId ?? '';
const location = useLocation();
const { data } = usePersonQuery(personId); const { data } = usePersonQuery(personId);
const person = data?.findUniquePerson; const person = data?.findUniquePerson;