Update documentation, add GraphiQL to docs (#175)
* Update docusaurus and fix security vulnerabilities * Begin cleanup docs * Remove redocusaurus * Add graphiql in doc * Add architecture schema * New tableIcons and cleanup docs
This commit is contained in:
Félix Malfait
@ -1 +0,0 @@
|
||||
# Data layer
|
||||
@ -1,4 +0,0 @@
|
||||
{
|
||||
"label": "Data layer",
|
||||
"position": 3
|
||||
}
|
||||
@ -1 +0,0 @@
|
||||
# Connecting to data sources
|
||||
@ -1 +0,0 @@
|
||||
# Mapping entities
|
||||
@ -1 +0,0 @@
|
||||
# Caching and optimization
|
||||
@ -1 +1,19 @@
|
||||
---
|
||||
sidebar_custom_props:
|
||||
icon: TbApps
|
||||
---
|
||||
|
||||
# Architecture
|
||||
|
||||
|
||||
import ThemedImage from '@theme/ThemedImage';
|
||||
|
||||
<ThemedImage
|
||||
alt="Docusaurus themed image"
|
||||
sources={{
|
||||
light: '/img/architecture.png',
|
||||
dark: '/img/architecture-dark.png',
|
||||
}}
|
||||
/>
|
||||
|
||||
|
||||
|
||||
@ -1 +0,0 @@
|
||||
# Core entities
|
||||
21
docs/docs/dev-docs/development/workflows.mdx
Normal file
21
docs/docs/dev-docs/development/workflows.mdx
Normal file
@ -0,0 +1,21 @@
|
||||
---
|
||||
sidebar_custom_props:
|
||||
icon: TbTopologyStar
|
||||
---
|
||||
# Workflows
|
||||
|
||||
The following steps assume that you have installed and configure the project with Docker.
|
||||
|
||||
## IDE Setup
|
||||
|
||||
If you are using VSCode, please use the `Dev Containers` extension to open the project in a container. This will allow you to run Visual Studio on top of the docker container. This will allow you to run the project without having to install node on your machine.
|
||||
|
||||
## Front tests
|
||||
|
||||
Run tests: `make front-test`
|
||||
Run coverage: `make front-coverage`
|
||||
Run storybook: `make front-storybook`
|
||||
|
||||
## Note
|
||||
|
||||
If you are using Docker install, make sure to ssh in the docker container during development to execute commands. You can also use `Makefile` to help you
|
||||
@ -1 +1,9 @@
|
||||
# Cloud setup
|
||||
---
|
||||
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
|
||||
@ -0,0 +1,14 @@
|
||||
# Documentation
|
||||
|
||||
The stack is composed of 3 different layers:
|
||||
|
||||
import ThemedImage from '@theme/ThemedImage';
|
||||
|
||||
<ThemedImage
|
||||
alt="Docusaurus themed image"
|
||||
sources={{
|
||||
light: '/img/architecture.png',
|
||||
dark: '/img/architecture-dark.png',
|
||||
}}
|
||||
/>
|
||||
|
||||
|
||||
@ -1,44 +1,54 @@
|
||||
---
|
||||
sidebar_position: 0
|
||||
slug: '/'
|
||||
sidebar_custom_props:
|
||||
icon: TbBolt
|
||||
---
|
||||
|
||||
# Twenty
|
||||
# Local Setup
|
||||
|
||||
Welcome to Twenty documentation!
|
||||
## Quickstart CLI
|
||||
|
||||
## High Level Overview
|
||||
We built a CLI to guide you through the different options.
|
||||
|
||||
Twenty development stack is composed of 3 different layers
|
||||
If you prefer to have more control and do things manually, go through the Docker section below.
|
||||
Otherwise run the following command to get started:
|
||||
```
|
||||
npx twenty-cli
|
||||
```
|
||||
|
||||
- front: our frontend React app
|
||||
- server: our backend that contain endpoint, crm logic, scripts, jobs...
|
||||
- storages: postgres
|
||||
|
||||
## Setup env variables
|
||||
## Docker
|
||||
|
||||
### 1. Pre-requisites
|
||||
|
||||
Make sure to 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
|
||||
|
||||
`cp ./infra/dev/.env.example ./infra/dev/.env` and fill with values
|
||||
|
||||
## Development environment setup with docker-compose (Recommended)
|
||||
### 4. Build
|
||||
|
||||
We also provide a containerized environment with Docker and orchestrated with docker-compose in case it is easier for you. This install will also provision a postgres container out of the box.
|
||||
We provide a containerized environment with Docker and orchestrated with docker-compose.
|
||||
This install will also provision a postgres container out of the box.
|
||||
|
||||
### Step 1: pre-requesites
|
||||
|
||||
Make sure to have the latest Docker and Docker-compose versions installed on your computer. You can run `docker-compose --version` to check if you have docker-compose installed and `docker --version` to check if you have docker installed.
|
||||
|
||||
### Step 2: docker build
|
||||
|
||||
Build docker containers.
|
||||
|
||||
The whole setup experience is happening in `infra/dev` folder. Make sure to be in this folder:
|
||||
The configuration is stored `infra/dev` folder.
|
||||
|
||||
```
|
||||
cd infra/dev
|
||||
make build
|
||||
```
|
||||
|
||||
### 5. Start
|
||||
|
||||
Always in the `infra/dev` folder:
|
||||
```
|
||||
make build
|
||||
make up
|
||||
```
|
||||
|
||||
@ -48,18 +58,35 @@ Once this is completed you should have:
|
||||
- server available on: http://localhost:3000/health
|
||||
- postgres: available on http://localhost:5432 that should contain `twenty` database
|
||||
|
||||
### Step 3: IDE setup
|
||||
|
||||
If you are using VSCode, please use the `Dev Containers` extension to open the project in a container. This will allow you to run Visual Studio on top of the docker container. This will allow you to run the project without having to install node on your machine.
|
||||
## 6. Development
|
||||
|
||||
### Note
|
||||
Documented [here](/development/workflows.md)
|
||||
|
||||
If you are using Docker install, make sure to ssh in the docker container during development to execute commands. You can also use `Makefile` to help you
|
||||
## Without Docker (Not recommended)
|
||||
|
||||
## Development workflow
|
||||
While Docker is the recommended way to run Twenty, you might want to keep a light install.
|
||||
|
||||
### Front tests
|
||||
### 1. Pre-requisites
|
||||
You need to have git, node and npm install on your computer.
|
||||
You also need to bring your own Postgres database.
|
||||
|
||||
Run tests: `make front-test`
|
||||
Run coverage: `make front-coverage`
|
||||
Run storybook: `make front-storybook`
|
||||
### 2. Git clone
|
||||
`git clone git@github.com:twentyhq/twenty.git`
|
||||
|
||||
### 3. Setup env variables
|
||||
|
||||
`cp ./infra/dev/.env.example ./infra/dev/.env` and fill with values
|
||||
|
||||
### 4. Build
|
||||
```
|
||||
cd front
|
||||
npm run
|
||||
```
|
||||
|
||||
### 5. Start
|
||||
|
||||
```
|
||||
cd front
|
||||
npm run
|
||||
```
|
||||
|
||||
@ -1 +1,8 @@
|
||||
# Self hosting
|
||||
---
|
||||
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!
|
||||
@ -1 +0,0 @@
|
||||
# Modules
|
||||
@ -1,4 +0,0 @@
|
||||
{
|
||||
"label": "Modules",
|
||||
"position": 4
|
||||
}
|
||||
@ -1 +0,0 @@
|
||||
# Analytics
|
||||
@ -1 +0,0 @@
|
||||
# Sales
|
||||
@ -1 +0,0 @@
|
||||
# Third party
|
||||
@ -1 +0,0 @@
|
||||
# Upcoming
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar_class_name: coming-soon
|
||||
sidebar_custom_props:
|
||||
icon: terminal
|
||||
icon: TbTerminal2
|
||||
---
|
||||
|
||||
|
||||
@ -1,5 +0,0 @@
|
||||
---
|
||||
sidebar_class_name: coming-soon
|
||||
---
|
||||
|
||||
# SDKs
|
||||
@ -1,8 +1,11 @@
|
||||
---
|
||||
sidebar_class_name: coming-soon
|
||||
sidebar_custom_props:
|
||||
icon: TbChartDots
|
||||
---
|
||||
|
||||
|
||||
|
||||
# Data collected
|
||||
...
|
||||
|
||||
|
||||
@ -1,7 +1,8 @@
|
||||
# Troubleshotting
|
||||
|
||||
## Common issues and solutions
|
||||
...
|
||||
---
|
||||
sidebar_custom_props:
|
||||
icon: TbBug
|
||||
---
|
||||
# Troubleshooting
|
||||
|
||||
## Reporting bugs
|
||||
...
|
||||
Please create an issue on Github: [https://github.com/twentyhq/twenty/issues/new](https://github.com/twentyhq/twenty/issues/new)
|
||||
@ -1,5 +0,0 @@
|
||||
---
|
||||
sidebar_class_name: coming-soon
|
||||
---
|
||||
|
||||
# Upgrade guide
|
||||
Reference in New Issue
Block a user