mukeshs/twenty_crm
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Update README and Documentation (#1875)

Browse Source 
* 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
This commit is contained in:
Nimra Ahmed
2023-10-07 14:24:44 +05:00
committed by GitHub
parent da68654caf
commit 7b6ee4e0bf
22 changed files with 14485 additions and 478 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/docs/start/getting-started.mdx
View File

@ -1,12 +1,15 @@
---
title: Getting Started
sidebar_position: 1
sidebar_custom_props:
icon: TbBolt
icon: TbRocket
---
import ThemedImage from '@theme/ThemedImage';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Getting Started
## Trying Twenty
There are three ways for you to get started with Twenty:
### 1. Cloud
The easiest way to quickly try the app is to signup on [app.twenty.com](https://app.twenty.com).
@ -14,6 +17,13 @@ The signup is free.
<ThemedImage sources={{light: "/img/light-sign-in.png", dark:"/img/dark-sign-in.png"}} style={{width:'100%', maxWidth:'800px'}}/>
## Developer documentation
### 2. Local
If you're a developer and would like to experiment or contribute to the app, you can install Twenty on your local environment. Follow our [local setup](/developer/local-setup) guide to get started.
### 3. Self-hosting
We provide self-hosting options if you want greater control over your data and want to run the app on your own server. Right now, Docker containers are the only hosting option we support. However we are actively working on providing simple options to self-host Twenty.
___
If you are looking to install the project locally, either to try it or to contribute, check out our [developer guide](/developer/local-setup).

26
docs/docs/start/overview.mdx Normal file
View File

@ -0,0 +1,26 @@
---
title: Overview
sidebar_position: 0
sidebar_custom_props:
icon: TbBolt
---
import ThemedImage from '@theme/ThemedImage';
Twenty is an Open Source CRM that provides flexibility, tailored to your business needs. It helps you break free from vendor lock-in and limitations, and provides the tools needed to harness the full potential of your data while ensuring a sleek and effortlessly intuitive design that teams will love to use.
<ThemedImage sources={{light: "../img/light-doc-preview.png", dark:"./img/dark-doc-preview.png"}} style={{width:'100%', maxWidth:'800px'}}/>
___
## Why did we create Twenty?
We’ve spent thousands of hours grappling with traditional CRMs/platforms like Pipedrive and Salesforce to align them with our business needs, only to end up frustrated—customizations are complex and the closed ecosystems of these platforms can feel restrictive.
We felt the need for a CRM solution that empowers rather than constrains, which inspired us to create Twenty. We’re building the next-generation open-source CRM that offers you the flexibility to shape it according to your business objectives and meet your team’s unique needs. We’ve packed Twenty with powerful features to give you full control and help you win more deals.
___
## Contributing
Contributions are what makes the open source community such an amazing place.
Code contributions through pull request are most welcome. See our [local setup guide](../developer/local-setup) to get started.
You can also contribute by creating an issue to report a bug you've spotted, joining our discussions or writing documentation.