admin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Simplify docs and remove Docker local setup (#4783)

Browse Source 
Having 2 different dev setups caused confusion, let's remove the Docker
local setup and recommend people install yarn locally.

Also simplified some docs by merging pages together, the recommend
self-hosting option is now the docker-compose / to adapt the
docker-compose.
This commit is contained in:
Félix Malfait
2024-04-03 16:38:28 +02:00
committed by GitHub
parent 1c6f0eb577
commit 7a34dc4910
24 changed files with 41 additions and 265 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
packages/twenty-docs/docs/start/local-setup/local-setup.mdx
View File

@ -16,14 +16,6 @@ Twenty aims for developer-friendliness, and your local installation should be up
If you have any questions or need help, you can join Twenty's [Discord](https://discord.gg/cx5n4Jzs57) server.
## MacOS and Linux users
It's better to use [yarn installation](/start/local-setup/yarn-setup) as this is the easiest way to get started.
But there's also an easy way to run the project with [Docker](/start/local-setup/docker-setup) that you can use if you are familiar with containerized environments.
## Windows users
Windows users can install the project through WSL2. [This guide](/start/local-setup/yarn-setup) can help you get started.
## Project structure
@ -31,10 +23,10 @@ The repository has the following structure:
```
twenty
└───packages // contains this documentation
└───twenty-front // contains the frontend code for the application
└───twenty-server // contains the backend code for the application
└───twenty-docker // contains docker configurations for development and production build
└───many other packages you are invited to discover such as twenty-docs, twenty-ui, eslint-rules, twenty-zapier...
└──────twenty-front // contains the frontend code for the application
└──────twenty-server // contains the backend code for the application
└──────twenty-docker // contains docker configurations for production build
└──────other packages that are less relevant as a first step such (docs, zapier app...)
```
## IDE Setup