Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Overview page & edited Getting Started page #1875

Merged
merged 8 commits into from
Oct 7, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Added Overview page
  • Loading branch information
nimraahmed committed Oct 5, 2023
commit 5dce29e9fe59d81651ca6f36da0c70bc0b2bae08
2 changes: 1 addition & 1 deletion docs/docs/developer/frontend/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
"customProps": {
"icon": "TbTerminal2"
}
}
}
24 changes: 16 additions & 8 deletions docs/docs/start/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -1,19 +1,27 @@
---
title: Getting Started
sidebar_position: 1
sidebar_custom_props:
icon: TbBolt
icon: TbDeviceDesktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't TbDeviceDesktop already used elsewhere? I didn't check but assume it would be for local setup. Make sure it isn't used twice, that would be ugly :)

---
import ThemedImage from '@theme/ThemedImage';

# Getting Started
# Getting started

## Trying Twenty
Twenty is designed to be developer-friendly, and your local installation should be up and running in a few minutes.

The easiest way to quickly try the app is to signup on [app.twenty.com](https://app.twenty.com).
In a nutshell:
- We recommend using `yarn` installation but we also provide an easy way to run the project with Docker.
- Twenty uses PostgreSQL as a database. If you don't have a PostgreSQL instance available, we also provide a one-line command to provision one through Docker.

The signup is free.
The repository is structured as follows:
```
twenty
└───docs // contains this documentation
└───front // contains the frontend code for the application
└───server // contains the backend code for the application
└───infra // contains docker configurations for development and production deployments
```

<ThemedImage sources={{light: "/img/light-sign-in.png", dark:"/img/dark-sign-in.png"}} style={{width:'100%', maxWidth:'800px'}}/>

## Developer documentation

If you are looking to install the project locally, either to try it or to contribute, check out our [developer guide](/developer/local-setup).
38 changes: 38 additions & 0 deletions docs/docs/start/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Overview
sidebar_position: 0
sidebar_custom_props:
icon: TbBolt
---
import ThemedImage from '@theme/ThemedImage';

# Twenty Documentation

Twenty is a modern CRM offering the flexibility of open source, advanced features, and a sleek design that puts teams in full control.

Twenty's codebase is adaptable, fostering a collaborative environment where every user can contribute. This extensible and modular design ensures our product evolves with you, cultivating mutually beneficial growth that promotes progress and innovation.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sorry I know we wrote all of this text in README (probably I committed it), but I really don't like it anymore haha.
I'll send you things we can take inspiration from in Discord


___

## Getting Started
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).

The signup is free.

<ThemedImage sources={{light: "/img/light-sign-in.png", dark:"/img/dark-sign-in.png"}} style={{width:'100%', maxWidth:'800px'}}/>

### 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.


___

## Developer documentation

If you are looking to install the project locally, either to try it or to contribute, check out our [developer guide](/developer/local-setup).
Loading