mirror of
https://github.com/twentyhq/twenty.git
synced 2024-12-23 03:51:36 +03: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
This commit is contained in:
Nimra Ahmed
GitHub
parent
da68654caf
commit
7b6ee4e0bf
@ -1,28 +0,0 @@
|
||||
|
||||
{
|
||||
"name": "Twenty Codespace",
|
||||
"image": "node:18.16.0",
|
||||
"features": {
|
||||
"ghcr.io/devcontainers-contrib/features/jshint:2": {}
|
||||
},
|
||||
"forwardPorts": [3000, 3001, 5432],
|
||||
"postCreateCommand": "echo 'To start the server, run yarn start command in server and front folder'",
|
||||
"customizations": {
|
||||
"vscode": {
|
||||
"extensions": [
|
||||
"styled-components.vscode-styled-components",
|
||||
"dbaeumer.vscode-eslint",
|
||||
"unifiedjs.vscode-mdx",
|
||||
"ms-vscode.makefile-tools",
|
||||
"ms-azuretools.vscode-docker",
|
||||
"esbenp.prettier-vscode",
|
||||
"GraphQL.vscode-graphql",
|
||||
"prisma.prisma",
|
||||
"unifiedjs.vscode-mdx",
|
||||
"yoavbls.pretty-ts-errors",
|
||||
"graphql.vscode-graphql-syntax",
|
||||
"graphql.vscode-graphql"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,6 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
DEBIAN_FRONTEND=noninteractive
|
||||
|
||||
make build
|
||||
make up
|
||||
@ -1,35 +0,0 @@
|
||||
version: "3.9"
|
||||
services:
|
||||
front:
|
||||
build:
|
||||
context: ..
|
||||
dockerfile: ./infra/prod/front/Dockerfile
|
||||
args:
|
||||
REACT_APP_SERVER_BASE_URL: "http://localhost:3000"
|
||||
ports:
|
||||
- "3001:3000"
|
||||
labels:
|
||||
dev.ergomake.env.replace-arg.REACT_APP_SERVER_BASE_URL: "https://{{ services.server.url }}"
|
||||
server:
|
||||
build:
|
||||
context: ..
|
||||
dockerfile: ./infra/prod/server/Dockerfile
|
||||
command: sh -c "yarn prisma migrate reset --force && node dist/src/main"
|
||||
ports:
|
||||
- "3000:3000"
|
||||
environment:
|
||||
DEBUG_MODE: false
|
||||
SIGN_IN_PREFILLED: true
|
||||
ACCESS_TOKEN_SECRET: "secret_jwt"
|
||||
LOGIN_TOKEN_SECRET: "secret_login_token"
|
||||
REFRESH_TOKEN_SECRET: "secret_refresh_token"
|
||||
PG_DATABASE_URL: "postgres://twenty:twenty@postgres:5432/default?connection_limit=1"
|
||||
FRONT_BASE_URL: "http://localhost:3000"
|
||||
labels:
|
||||
dev.ergomake.env.replace-env.FRONT_BASE_URL: "https://{{ services.server.url }}"
|
||||
postgres:
|
||||
build: ../infra/dev/postgres
|
||||
environment:
|
||||
POSTGRES_PASSWORD: twenty
|
||||
ports:
|
||||
- "5432"
|
||||
72
.github/CONTRIBUTING.md
vendored
Normal file
72
.github/CONTRIBUTING.md
vendored
Normal file
@ -0,0 +1,72 @@
|
||||
# Contributing to Twenty
|
||||
|
||||
Thank you for considering contributing to Twenty! We welcome contributions from the community to help us build and improve our open-source CRM platform. This guide outlines the process for contributing to our project.
|
||||
|
||||
<br>
|
||||
|
||||
## Getting Started
|
||||
|
||||
Before you start contributing, please take a moment to review the following resources:
|
||||
|
||||
- [Twenty Repository](https://github.com/twentyhq/twenty): The main repository where development takes place.
|
||||
- [Documentation](https://docs.twenty.com): Our project documentation to understand the project structure and guidelines.
|
||||
|
||||
<br>
|
||||
|
||||
## Contributing Guidelines
|
||||
|
||||
1. **Fork the Repository:** Click on the 'Fork' button in the upper right corner of the repository's GitHub page. This will create a copy of the repository in your GitHub account.
|
||||
|
||||
2. **Clone the Repository:** Clone your forked repository to your local machine using `git clone`.
|
||||
|
||||
```shell
|
||||
git clone https://github.com/yourusername/twenty.git
|
||||
cd twenty
|
||||
```
|
||||
|
||||
3. **Create a Branch:** Create a new branch for your contribution with a descriptive name.
|
||||
```shell
|
||||
git checkout -b feature/your-feature-name
|
||||
```
|
||||
|
||||
4. **Make Changes:** Make your desired changes and ensure that your code adheres to our coding standards.
|
||||
|
||||
5. **Test Locally:** Test your changes locally to ensure they work as expected.
|
||||
|
||||
6. **Commit Changes:** Commit your changes with a clear and concise commit message.
|
||||
|
||||
```shell
|
||||
Copy code
|
||||
git commit -m "Add your detailed description here"
|
||||
```
|
||||
7. **Push Changes:** Push your changes to your forked repository.
|
||||
|
||||
```shell
|
||||
git push origin feature/your-feature-name
|
||||
```
|
||||
|
||||
8. **Create a Pull Request:** Go to the original Twenty repository and create a pull request. Please provide a detailed description of your changes.
|
||||
|
||||
9. **Code Review:** Your pull request will undergo a code review. Be prepared to make any necessary adjustments based on feedback.
|
||||
|
||||
10. **Merge:** Once your pull request is approved, it will be merged into the main repository.
|
||||
|
||||
<br>
|
||||
|
||||
## Reporting Issues
|
||||
|
||||
If you encounter any issues or have suggestions for improvements, please feel free to create an issue on our GitHub repository. When reporting issues, please provide as much detail as possible to help us understand and address the problem effectively.
|
||||
|
||||
<br>
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
Please note that by contributing to this project, you are expected to follow our Code of Conduct. We strive to maintain a welcoming and inclusive community for all contributors.
|
||||
|
||||
<br>
|
||||
|
||||
## License
|
||||
|
||||
By contributing to Twenty, you agree that your contributions will be licensed under the [AGPL-3.0 License](https://github.com/twentyhq/twenty/blob/main/LICENSE).
|
||||
|
||||
Thank you for considering contributing to Twenty. Your contributions help us make our CRM platform even better!
|
||||
0
SECURITY.md → .github/SECURITY.md
vendored
0
SECURITY.md → .github/SECURITY.md
vendored
123
README.md
123
README.md
@ -7,11 +7,12 @@
|
||||
</p>
|
||||
|
||||
<h2 align="center" >A Modern Open Source CRM </h3>
|
||||
<p align="center">Crafted with Precision. Built for Success.</p>
|
||||
<p align="center">CRM flexibility, tailored to your unique business needs</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">Our Story</a> · 💬 <a href="https://discord.gg/cx5n4Jzs57">Discord</a> · ✏️ <a href="https://www.figma.com/file/xt8O9mFeLl46C5InWwoMrN/Twenty">Figma</a><p>
|
||||
<p align="center">🌐 <a href="https://twenty.com">Website</a> · 📚 <a href="https://docs.twenty.com">Documentation</a> · 💻 <a href="https://app.twenty.com/">Demo</a> · 💬 <a href="https://discord.gg/cx5n4Jzs57">Discord</a> · ✏️ <a href="https://www.figma.com/file/xt8O9mFeLl46C5InWwoMrN/Twenty">Figma</a><p>
|
||||
<br />
|
||||
|
||||
|
||||
<p align="center">
|
||||
<a href="https://www.twenty.com">
|
||||
<picture>
|
||||
@ -21,31 +22,37 @@
|
||||
</picture>
|
||||
</a>
|
||||
</p>
|
||||
<br>
|
||||
|
||||
# Quickstart
|
||||
Access the alpha version at [app.twenty.com](https://app.twenty.com). Click-to-deploy buttons for Render and Railway are coming soon.
|
||||
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.
|
||||
|
||||
For local setup, refer to [the documentation](https://docs.twenty.com/developer/local-setup). Expect a quick and easy startup.
|
||||
|
||||
# About
|
||||
We are building an Open Source CRM designed to be: enjoyable to use, easily extendable, and perfectly in-sync with your data.
|
||||
|
||||
Twenty was created as a Public Benefits Company. This means we're legally bound to consider the impact of our decisions not just on shareholders, but also on society.
|
||||
|
||||
Our belief is simple: **great companies focus on helping people** and meeting their users' needs above all. The decision to go open source was therefore a natural one for us. It fits with our aim to do what's right and with our goals for the business:
|
||||
|
||||
**For our users:**
|
||||
- We are committed to complete transparency regarding what we are building, allowing you to take a look inside and observe the intricate machinery in action.
|
||||
- This enables you to be a decisive actor of the roadmap by contributing or building your own tool.
|
||||
|
||||
**For the developer community:**
|
||||
- We offer a self-hosted CRM solution that you can use for free, keeping your data on your own servers.
|
||||
- We are developing a collection of reusable components, such as tables or kanban boards (coming soon).
|
||||
- We are introducing a new approach to CRM extensibility, one that can be managed by your engineering team instead of relying on external consultants (coming soon).
|
||||
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.
|
||||
|
||||
|
||||
# Features
|
||||
Explore [Twenty CRM](https://app.twenty.com/).
|
||||
|
||||
<br>
|
||||
|
||||
# Why Choose Twenty?
|
||||
We understand that the CRM landscape is vast. So why should you choose us?
|
||||
|
||||
⛓️ **Full control, Full Freedom:** With Twenty, you aren’t just a CRM user; you’re also a co-creator. Join us in shaping the future of CRM through open source collaboration. Break free from vendor lock-in and limitations.
|
||||
|
||||
📊 **Data, Your Way:** Your data should serve your business, not hinder it. Twenty allows you to harness the full potential of your data, securely and on your own terms.
|
||||
|
||||
🎨 **Effortlessly Intuitive:** We’ve made sure that Twenty’s design isn’t just beautiful, but also functional.
|
||||
It’s a CRM that your team will love to use.
|
||||
<br>
|
||||
|
||||
# Our Commitment
|
||||
|
||||
Twenty is incorporated as a Public Benefits Company, which means we’re legally bound to consider the broader impact of our decisions on all stakeholders. We strive to build software that creates value for a wider ecosystem, not just our company. Our success is intertwined with the success of our users, contributors, and the open source community at large.
|
||||
|
||||
<br>
|
||||
|
||||
# What You Can Do With Twenty
|
||||
We are currently in the development phase of Twenty's alpha version.
|
||||
|
||||
Don't hesitate to flag a specific need by creating an issue.
|
||||
|
||||
Below are the features we have implemented to date.
|
||||
@ -56,7 +63,7 @@ Below are the features we have implemented to date.
|
||||
<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: 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/visualise-customer-light.png" alt="Companies view" />
|
||||
</picture>
|
||||
</p>
|
||||
|
||||
@ -66,68 +73,66 @@ Below are the features we have implemented to date.
|
||||
<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: 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/follow-your-deals-light.png" alt="Companies view" />
|
||||
</picture>
|
||||
</p>
|
||||
|
||||
## Rich notes (and soon tasks) that are displayed in a timeline:
|
||||
## See rich notes tasks displayed in a timeline:
|
||||
|
||||
<p align="center">
|
||||
<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: 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/rich-notes-light.png" alt="Companies view" />
|
||||
</picture>
|
||||
</p>
|
||||
|
||||
## Create tasks on records
|
||||
|
||||
<p align="center">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/create-tasks-dark.png">
|
||||
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/create-tasks-light.png">
|
||||
<img src="./docs/static/img/create-tasks-light.png" alt="Companies view" />
|
||||
</picture>
|
||||
</p>
|
||||
|
||||
|
||||
## Navigate quickly through the app using keyboard shortcuts and search:
|
||||
|
||||
<p align="center">
|
||||
<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: 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/shortcut-navigation-light.png" alt="Companies view" />
|
||||
</picture>
|
||||
</p>
|
||||
|
||||
# Upcoming features
|
||||
<br>
|
||||
|
||||
Coming next:
|
||||
⚙️ A notification center<br>
|
||||
⚙️ More standard fields<br>
|
||||
⚙️ AI/LLM integration to Notes<br>
|
||||
⚙️ More pipelines and table customization<br>
|
||||
⚙️ A lot of bug fixes and other improvements<br>
|
||||
⚙️ Auto-logging emails<br>
|
||||
# What's In Store
|
||||
|
||||
Coming later this year:
|
||||
📅 Advanced search and filters<br>
|
||||
📅 Data connectors<br>
|
||||
📅 Custom fields<br>
|
||||
📅 Custom objects<br>
|
||||
📅 +++<br>
|
||||
Here’s what you can look forward to:
|
||||
|
||||
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)
|
||||
⏳ **Frequent updates:** We’re shipping fast! Expect regular updates and new features that enhance your CRM experience.
|
||||
|
||||
# Documentation
|
||||
The doc is available on [docs.twenty.com](https://docs.twenty.com).
|
||||
🔗 **Extensibility:** We’re putting the power in your hands. Soon, you’ll have the tools to extend and customize your CRM to precisely fit your business needs. No more reliance on external consultants; you’re in control.
|
||||
|
||||
If you have any question feel free to ask on our [Discord](https://discord.gg/cx5n4Jzs57).
|
||||
<br>
|
||||
|
||||
# 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/).
|
||||
# Join the Movement
|
||||
|
||||
- Star the repo
|
||||
- Join [discussions](https://github.com/twentyhq/twenty/discussions) and track [issues](https://github.com/twentyhq/twenty/issues)
|
||||
- Follow us on [Twitter](https://twitter.com/twentycrm) or [LinkedIn](https://www.linkedin.com/company/twenty/)
|
||||
- Join our [Discord](https://twenty.com/discord)
|
||||
- [Contributions](https://github.com/twentyhq/twenty/contribute) are, of course, most welcome!
|
||||
|
||||
# Office hours
|
||||
Want to meet the team? Get direct support?
|
||||
Feel free to book a slot during our office hours.
|
||||
<br>
|
||||
|
||||
# Get Started
|
||||
|
||||
Dive into Twenty today and experience the power of open-source CRM on your own terms.
|
||||
|
||||
🚀 [Get Started with Twenty](https://docs.twenty.com/developer/local-setup).
|
||||
|
||||
<a href="https://cal.com/team/twenty?utm_source=banner&utm_campaign=oss">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://cal.com/book-with-cal-dark.svg">
|
||||
<source media="(prefers-color-scheme: light)" srcset="https://cal.com/book-with-cal-light.svg">
|
||||
<img alt="Book us with Cal.com" src="https://cal.com/book-with-cal-light.svg" height="40">
|
||||
</picture>
|
||||
</a>
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
{
|
||||
"label": "Developer guide",
|
||||
"position": 2
|
||||
"label": "Contributor guide",
|
||||
"position": 3
|
||||
}
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
sidebar_position: 3
|
||||
sidebar_custom_props:
|
||||
icon: TbVocabulary
|
||||
---
|
||||
@ -6,4 +6,4 @@
|
||||
"customProps": {
|
||||
"icon": "TbTerminal2"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,15 +1,13 @@
|
||||
---
|
||||
sidebar_position: 0
|
||||
title: Local Setup
|
||||
sidebar_position: 1
|
||||
sidebar_custom_props:
|
||||
icon: TbDeviceDesktop
|
||||
---
|
||||
|
||||
import ThemedImage from '@theme/ThemedImage';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Local Setup
|
||||
|
||||
This section will guide you through the Twenty installation on your local environment.
|
||||
Twenty is designed to be developer-friendly, and your local installation should be up and running in a few minutes.
|
||||
|
||||
In a nutshell:
|
||||
@ -24,25 +22,34 @@ twenty
|
||||
└───server // contains the backend code for the application
|
||||
└───infra // contains docker configurations for development and production deployments
|
||||
```
|
||||
___
|
||||
|
||||
## Yarn install (recommended)
|
||||
# Recommended: Yarn Installation
|
||||
|
||||
**Note:** `npm` currently does not support local packages satisfactorily. We strongly recommend using `yarn` instead.
|
||||
|
||||
### 1. Pre-requisites
|
||||
## Prerequisites
|
||||
|
||||
You need to have [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git), [node](https://nodejs.org/en/download) and [yarn](https://classic.yarnpkg.com/lang/en/docs/install/) installed on your computer.
|
||||
Before you can install and use Twenty, make sure you install the following on your computer:
|
||||
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
|
||||
- [Node](https://nodejs.org/en/download)
|
||||
- [yarn](https://classic.yarnpkg.com/lang/en/docs/install/)
|
||||
|
||||
---
|
||||
|
||||
## Step #1: Git Clone
|
||||
|
||||
In your terminal, run the following command:
|
||||
|
||||
### 2. Git clone
|
||||
```
|
||||
git clone git@github.com:twentyhq/twenty.git
|
||||
```
|
||||
|
||||
|
||||
### 3. PostgreSQL database
|
||||
You also need to have a PostgreSQL database available. If you already have one available, you can skip this step.
|
||||
## Step #2: Set up PostgreSQL Database
|
||||
You need to have a PostgreSQL database available to be able to use Twenty. If you already have one available, you can skip this step.
|
||||
|
||||
If you don't, you can provision one through `docker` using the following command:
|
||||
If you don't, you can provision one through `docker` using the following commands:
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="docker" label="Docker" default>
|
||||
@ -54,26 +61,54 @@ If you don't, you can provision one through `docker` using the following command
|
||||
|
||||
This will create a Docker container, exposing a PostgresSQL instance at [http://localhost:5432](http://localhost:5432).
|
||||
|
||||
This instance is containing two databases: `default` and `test`
|
||||
This instance contains two databases: `default` and `test`
|
||||
You can access them using `twenty` postgres user (password: `twenty`)
|
||||
</TabItem>
|
||||
<TabItem value="linux-wsl" label="Linux / Windows WSL">
|
||||
|
||||
Install PostgresSQL on WSL2:
|
||||
To install PostgresSQL on WSL2, use the following commands:
|
||||
|
||||
```bash
|
||||
cd twenty/infra/dev/scripts && sudo ./setup-database.sh
|
||||
sudo apt update
|
||||
sudo apt install postgresql postgresql-contrib
|
||||
```
|
||||
|
||||
This script will install and setup PostgreSQL with dependencies.
|
||||
Start postgresql service and connect to the database using default `postgres` user:
|
||||
|
||||
After successful setup, database will contain two databases: `default` and `test`,
|
||||
You can access them using `twenty` postgres user (password: `twenty`)
|
||||
```bash
|
||||
sudo service postgresql start
|
||||
sudo -u postgres psql
|
||||
```
|
||||
|
||||
Create two databases:
|
||||
|
||||
```sql
|
||||
CREATE DATABASE "default";
|
||||
CREATE DATABASE "test";
|
||||
```
|
||||
|
||||
Create a user `twenty` with password `twenty`:
|
||||
|
||||
```sql
|
||||
CREATE USER twenty PASSWORD 'twenty';
|
||||
ALTER USER twenty CREATEDB;
|
||||
```
|
||||
|
||||
Create `metadata` schema:
|
||||
```sql
|
||||
CREATE SCHEMA IF NOT EXISTS "metadata";
|
||||
GRANT ALL ON SCHEMA metadata TO twenty;
|
||||
```
|
||||
|
||||
Activate `uuid-ossp` extension:
|
||||
```sql
|
||||
CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
### 4. Setup env variables
|
||||
## Step #3: Setup env variables
|
||||
|
||||
Twenty requires a few environment variables to be set. Locally, we recommend setting them through a `.env` file.
|
||||
|
||||
@ -83,11 +118,11 @@ cp ./front/.env.example ./front/.env
|
||||
cp ./server/.env.example ./server/.env
|
||||
```
|
||||
|
||||
### 5. Server setup
|
||||
## Step #4: Server setup
|
||||
|
||||
**Note:** we recommend that you use `nvm` to install the correct `node` version. We have added a `server/.nvmrc` to ensure all contributors are using the same version.
|
||||
**Note:** We recommend that you use `nvm` to install the correct `node` version. We have added a `server/.nvmrc` to ensure all contributors are using the same version.
|
||||
|
||||
To build Twenty server and seed some data into your database:
|
||||
To build Twenty server and seed some data into your database, run the following commands:
|
||||
```bash
|
||||
cd server
|
||||
nvm install #recommended
|
||||
@ -97,11 +132,12 @@ yarn prisma:reset
|
||||
yarn start:dev
|
||||
```
|
||||
|
||||
Twenty server will be running at [http://localhost:3000](http://localhost:3000).
|
||||
Twenty's server will be up and running at [http://localhost:3000](http://localhost:3000).
|
||||
|
||||
### 6. Frontend setup
|
||||
## Step #5: Frontend setup
|
||||
|
||||
**Note:** similarly, we recommend that you use `nvm` to install the right node version.
|
||||
**Note:** For the frontend setup, too, we recommend using `nvm` to install the right node version.
|
||||
To set up the frontend, run the following commands in your terminal:
|
||||
|
||||
```bash
|
||||
cd ../front
|
||||
@ -111,31 +147,31 @@ yarn
|
||||
yarn start
|
||||
```
|
||||
|
||||
Twenty front will be running at [http://localhost:3001](http://localhost:3001).
|
||||
Twenty's frontend will be running at [http://localhost:3001](http://localhost:3001). Simply login using our seeded demo account: `tim@apple.dev` to start using Twenty.
|
||||
|
||||
### 7. Sign in to your local Twenty installation
|
||||
---
|
||||
|
||||
Open [http://localhost:3001](http://localhost:3001) in your web browser. You can login using our seeded demo account: `tim@apple.dev`.
|
||||
|
||||
## Docker install
|
||||
# Docker Installation
|
||||
|
||||
You can also provision the project with Docker. This comes with a few advantages:
|
||||
- It provides the exact same environment as our core developer team.
|
||||
- It includes some additional dependencies (such as `playwright`) that you might need if you wish to contribute to some advanced areas of the project.
|
||||
- It provisions a PostgreSQL database.
|
||||
|
||||
### 1. Pre-requisites
|
||||
## Prerequisites
|
||||
|
||||
Make sure you have the latest `Docker` and [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) versions installed on your computer.
|
||||
|
||||
You can run `docker --version` to verify the installation.
|
||||
|
||||
### 2. Git clone
|
||||
## Step #1: Git Clone
|
||||
In your terminal, run the following command:
|
||||
|
||||
```bash
|
||||
git clone git@github.com:twentyhq/twenty.git
|
||||
```
|
||||
|
||||
### 3. Setup env variables
|
||||
## Step #2: Setup env variables
|
||||
|
||||
Twenty requires a few environment variables to be set. Locally, we recommend setting them through `.env` files.
|
||||
|
||||
@ -153,18 +189,18 @@ PG_DATABASE_URL=postgres://twenty:twenty@postgres:5432/default?connection_limit=
|
||||
```
|
||||
|
||||
|
||||
### 4. Build
|
||||
## Step #3: Build
|
||||
|
||||
We provide an environment containerized with Docker and orchestrated with `docker-compose`.
|
||||
This installation method will also provision a PostgreSQL container.
|
||||
|
||||
**Note:** the configuration for the build is stored in the `infra/dev` folder, but you can run `make` commands directly from the root folder.
|
||||
**Note:** The configuration for the build is stored in the `infra/dev` folder, but you can run `make` commands directly from the root folder.
|
||||
|
||||
```bash
|
||||
make build
|
||||
```
|
||||
|
||||
### 5. Migrate & seed
|
||||
## Step #4: Migrate & seed
|
||||
|
||||
Before running the project, you need to initialize the database by running the migrations and seed.
|
||||
|
||||
@ -178,9 +214,9 @@ Run database migrations, generate prisma client, and seed:
|
||||
make server-prisma-reset
|
||||
```
|
||||
|
||||
### 6. Start Twenty
|
||||
## Step #5: Start Twenty
|
||||
|
||||
Run the project with the following commands from `root folder`:
|
||||
Run the project with the following commands from the `root folder`:
|
||||
|
||||
```bash
|
||||
make server-start
|
||||
@ -191,15 +227,13 @@ make front-start
|
||||
```
|
||||
|
||||
You should now have:
|
||||
- **front** available on: [http://localhost:3001](http://localhost:3001)
|
||||
- **server** available on: [http://localhost:3000/graphql](http://localhost:3000/graphql)
|
||||
- **postgres** available on [http://localhost:5432](http://localhost:5432) and containing database named `default`
|
||||
- **Frontend** available on: [http://localhost:3001](http://localhost:3001)
|
||||
- **Server** available on: [http://localhost:3000/graphql](http://localhost:3000/graphql)
|
||||
- **Postgres** available on [http://localhost:5432](http://localhost:5432) and containing database named `default`
|
||||
|
||||
### 7. Sign in to your local Twenty installation
|
||||
Sign in using our seeded demo account `tim@apple.dev` (password: `Applecar2025`) to start using Twenty
|
||||
|
||||
Open [http://localhost:3001](http://localhost:3001) and sign in using our seeded demo account `tim@apple.dev` (password: `Applecar2025`)
|
||||
|
||||
### 8. (Optional)
|
||||
### Optional
|
||||
|
||||
If you don't want to use the `make` command and work directly from the container, you can also ssh directly into the container:
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
{
|
||||
"label": "Self-Hosting",
|
||||
"position": 3
|
||||
"position": 2
|
||||
}
|
||||
|
||||
@ -11,7 +11,7 @@ Refer to this list to see what future options will be available.
|
||||
|
||||
## Production docker containers
|
||||
|
||||
We provide a production-ready set of `Dockerfile`s to allow you to build your own image and deploy it to your favorite cloud provider (Amazon Web Services, Google Cloud Platform, etc.).
|
||||
We provide a production-ready set of `Dockerfiles` to allow you to build your own image and deploy it to your favorite cloud provider (Amazon Web Services, Google Cloud Platform, etc.).
|
||||
|
||||
You will find these in the [infra/prod/front/Dockerfile](https://github.com/twentyhq/twenty/blob/main/infra/prod/front/Dockerfile) and [infra/prod/server/Dockerfile](https://github.com/twentyhq/twenty/blob/main/infra/prod/server/Dockerfile) files.
|
||||
|
||||
|
||||
@ -1,14 +1,14 @@
|
||||
---
|
||||
id: homepage
|
||||
sidebar_position: 0
|
||||
hide_title: true
|
||||
|
||||
sidebar_class_name: display-none
|
||||
title: Welcome
|
||||
custom_edit_url: null
|
||||
---
|
||||
import ThemedImage from '@theme/ThemedImage';
|
||||
|
||||
# Introduction
|
||||
|
||||
|
||||
Twenty is an Open Source CRM.
|
||||
<ThemedImage sources={{light: "./img/light-doc-preview.png", dark:"./img/dark-doc-preview.png"}} style={{width:'100%', maxWidth:'800px'}}/>
|
||||
|
||||
@ -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
26
docs/docs/start/overview.mdx
Normal 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.
|
||||
@ -42,7 +42,7 @@ const config = {
|
||||
sidebarPath: require.resolve('./sidebars.js'),
|
||||
sidebarCollapsible: false,
|
||||
routeBasePath: '/',
|
||||
editUrl: 'https://github.com/twentyhq/twenty/edit/main/docs/docs/',
|
||||
editUrl: 'https://github.com/twentyhq/twenty/edit/main/docs/',
|
||||
},
|
||||
blog: false,
|
||||
theme: {
|
||||
|
||||
13607
docs/package-lock.json
generated
Normal file
13607
docs/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
@ -25,4 +25,6 @@ export {
|
||||
TbTopologyStar,
|
||||
TbVocabulary,
|
||||
TbZoomQuestion,
|
||||
} from "react-icons/tb";
|
||||
TbRocket
|
||||
} from "react-icons/tb";
|
||||
|
||||
|
||||
BIN
docs/static/img/create-tasks-dark.png
vendored
Normal file
BIN
docs/static/img/create-tasks-dark.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 743 KiB |
BIN
docs/static/img/create-tasks-light.png
vendored
Normal file
BIN
docs/static/img/create-tasks-light.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 899 KiB |
897
docs/yarn.lock
897
docs/yarn.lock
File diff suppressed because it is too large
Load Diff
@ -1 +0,0 @@
|
||||
gha_enabled: False
|
||||
Loading…
Reference in New Issue
Block a user