7a34dc4910
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.
39 lines
1.5 KiB
Plaintext
39 lines
1.5 KiB
Plaintext
---
|
|
title: IDE Setup
|
|
sidebar_position: 4
|
|
description: Get the best developer UX with VSCode
|
|
sidebar_custom_props:
|
|
icon: TbBrandVscode
|
|
---
|
|
|
|
This section will help you set up your IDE for the project. If you haven't set up your development environment, please refer to the [local setup](/start/local-setup) section.
|
|
|
|
|
|
## Visual Studio Code
|
|
|
|
You can use any IDE you prefer, but Visual Studio Code is the choice of the core team, and has lots of extensions and settings to share with you.
|
|
|
|
|
|
### Step 1: Installation
|
|
|
|
You can download Visual Studio Code from [here](https://code.visualstudio.com/download). Depending on your operating system, you can download the appropriate version.
|
|
|
|
### Step 2: Open Project
|
|
|
|
Once you install Visual Studio Code, you can open the project by clicking on `File > Open Folder` and selecting `twenty` project root folder.
|
|
|
|
<div style={{textAlign: 'center'}}>
|
|
<img src="/img/contributor/ide-project-open.png" alt="Visual Studio Code: Open Twenty project" width="90%" />
|
|
</div>
|
|
|
|
### Step 3: Extensions
|
|
|
|
You can use the recommended extensions for the project. You will find them in `.vscode/extensions.json` file. VSCode should prompt you to install the recommended extensions when you open the project.
|
|
|
|
<div style={{textAlign: 'center'}}>
|
|
<img src="/img/contributor/ide-extensions.png" alt="Visual Studio Code: Install recommended extensions" width="90%" />
|
|
</div>
|
|
|
|
## You are all set
|
|
|
|
You are all set to start contributing to the project. If you have any questions, feel free to reach out to the team on [Discord](https://discord.gg/cx5n4Jzs57). |