mirror of
https://github.com/lingble/twenty.git
synced 2025-10-30 12:22:29 +00:00
edc060fce7
* new contributor guide folder architecture * update content pass 1 * Prepare UI component folder to receive componentns * Add component doc example for button * Fix broken links * Fix broken links * Fix images
59 lines
1.9 KiB
Plaintext
59 lines
1.9 KiB
Plaintext
---
|
|
title: Windows WSL Setup
|
|
sidebar_position: 3
|
|
sidebar_custom_props:
|
|
icon: TbBrandWindows
|
|
---
|
|
|
|
## Install WSL
|
|
|
|
Open PowerShell as Administrator and run:
|
|
|
|
Install WSL. Follow https://learn.microsoft.com/en-us/windows/wsl/install
|
|
|
|
```powershell
|
|
wsl --install
|
|
```
|
|
|
|
You should be prompted to restart your computer. If not, restart it manually.
|
|
|
|
Upon restart, a powershell window will open and install Ubuntu. This may take a few minutes.
|
|
You will be prompted to create a username and password for your Ubuntu installation.
|
|
|
|
<div style={{textAlign: 'center'}}>
|
|
<img src="/img/contributor/wsl-complete.png" alt="Visual Studio Code: Open in container" width="90%" />
|
|
</div>
|
|
|
|
## Setup your developer environment
|
|
|
|
### Install Git
|
|
|
|
Follow: https://learn.microsoft.com/en-us/windows/wsl/tutorials/wsl-git
|
|
|
|
```
|
|
sudo apt-get install git
|
|
```
|
|
Then, configure your git user name and email using the following commands, replacing name and email with your own. These details will be associated with any commits that you create:
|
|
|
|
```
|
|
git config --global user.name "Your Name"
|
|
git config --global user.email "youremail@domain.com"
|
|
```
|
|
|
|
**Note:$$ If you don't have a Github account, create one now with the corresponding email address. We recommend that you setup a SSH key for your Github account. Follow the instructions here: https://docs.github.com/fr/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent
|
|
|
|
### Install Node.js, nvm, Yarn
|
|
|
|
```bash
|
|
sudo apt-get install curl
|
|
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
|
|
curl -o- -L https://yarnpkg.com/install.sh | bash
|
|
```
|
|
|
|
Close and reopen your terminal to start using nvm or run the following to use it now:
|
|
|
|
### Install Twenty project
|
|
|
|
You are ready to install Twenty project. Follow the [Yarn install guide](/contributor/local-setup#yarn-install-recommended) instructions.
|
|
We don't recommend to use Docker on WSL as it adds an extra layer of complexity.
|