Improve documentation (#349)

* Improve documentation content
* Improve documentation style
This commit is contained in:
Félix Malfait
2023-06-21 16:23:31 -07:00
committed by GitHub
parent e679f45615
commit a65853dc2e
31 changed files with 15592 additions and 2194 deletions

View File

@ -0,0 +1,4 @@
{
"label": "Getting started",
"position": 1
}

View File

@ -0,0 +1,9 @@
---
sidebar_custom_props:
icon: TbCloud
---
# Cloud setup
The easiest way to quickly try the app is to signup on [app.twenty.com](https://app.twenty.com).
Signup is free

View File

@ -0,0 +1,151 @@
---
sidebar_position: 0
sidebar_custom_props:
icon: TbBolt
---
# Local Setup
We recommend using Docker to avoid potential problems with version compatibility, but it's also fairly simple to run the app directly on your machine.
## With Docker
### 1. Pre-requisites
Make sure you have the latest Docker and Docker-compose versions installed on your computer.
You can run `docker-compose --version` and `docker --version` to check they are installed.
### 2. Git clone
```
git clone git@github.com:twentyhq/twenty.git
```
### 3. Setup env variables
Go to the cloned folder (`cd twenty`). Then copy the env files:
```
cp ./infra/dev/.env.example ./infra/dev/.env
cp ./front/.env.example ./front/.env
cp ./server/.env.example ./server/.env
```
Default values should work out of the box with the docker setup.
### 4. Build
We provide a containerized environment with Docker and orchestrated with docker-compose.
This install will also provision a Postgres container.
The configuration is stored `infra/dev` folder.
```
cd infra/dev
make build
```
### 5. Auth setup
Right now the only way to authenticate yourself is to setup Google Sign-in in `server/.env`
We will add an easier option soon.
### 6. Migrate & seed
Before running the project, we need to apply database init and migrations and run the seed.
Always go the `infra/dev` folder to run the `make` commands.
Start the containers:
```
make up
```
Run database migrations:
```
make server-prisma-migrate
```
Generate prisma client
```
make server-prisma-generate-client
```
Seed the database:
```
make server-prisma-seed
```
### 7. Start
Once this is completed you can run the project with the following commands:
front:
```
make front-start
```
server:
```
make-server start
```
- front available on: http://localhost:3001
- server available on: http://localhost:3000/healthz
- postgres: available on http://localhost:5432 and should contain database named `twenty`
### 8. Development
Documented [here](../dev/workflows.mdx)
## Without Docker
While Docker is the recommended way to run Twenty, you might want to run the project directly on your machine.
### 1. Pre-requisites
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.
You also need to bring your own Postgres database.
### 2. Git clone
```
git clone git@github.com:twentyhq/twenty.git
```
### 3. Setup env variables
Make a copy of .env.example files:
```
cp ./front/.env.example ./front/.env
cp ./server/.env.example ./server/.env
```
Most default value should work out of the box, but don't forget to update the database connection string.
### 4. Build
On the frontend:
```
cd front
yarn
```
On the server side:
```
cd server
yarn
yarn prisma:migrate
```
You can also run `yarn prisma:seed` to seed the database with mock data.
### 5. Auth Setup
Right now the only way to authenticate yourself is to setup Google Sign-in in `server/.env`
We will add an easier option soon.
### 6. Start
On the frontend:
```
cd front
yarn start
```
On the server side:
```
cd server
yarn start
```

View File

@ -0,0 +1,8 @@
---
sidebar_custom_props:
icon: TbServer
---
# Self hosting
We will soon be working on options to make it easy to self host the app (click-to-deploy buttons for Heroku, Railway...).
Contributions are welcome!