Skip to content

Commit

Permalink
update local-setup docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Hitarthsheth07 committed Oct 17, 2024
1 parent c07650f commit 7d62010
Showing 1 changed file with 17 additions and 13 deletions.
30 changes: 17 additions & 13 deletions packages/twenty-website/src/content/developers/local-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,15 +48,28 @@ git config --global user.name "Your Name"
git config --global user.email "[email protected]"
```

3. Install Node.js, nvm, yarn
3. Install nvm, node.js and yarn
<ArticleWarning>

Use `nvm` to install the correct `node` version. The `.nvmrc` ensures all contributors use the same version.

</ArticleWarning>

```bash
sudo apt-get install curl

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
```
Close and reopen your terminal to use nvm. Then run the following commands.

```bash

nvm install # installs recommended node version

nvm use # use recommended node version

corepack enable
```
Close and reopen your terminal to start using nvm.

</ArticleTab>
</ArticleTabs>
Expand Down Expand Up @@ -186,17 +199,8 @@ cp ./packages/twenty-server/.env.example ./packages/twenty-server/.env
```

## Step 6: Installing dependencies

<ArticleWarning>

Use `nvm` to install the correct `node` version. The `.nvmrc` ensures all contributors use the same version.

</ArticleWarning>

To build Twenty server and seed some data into your database, run the following commands:
To build Twenty server and seed some data into your database, run the following command:
```bash
nvm install # installs recommended node version
nvm use # use recommended node version
yarn
```

Expand Down Expand Up @@ -279,4 +283,4 @@ This should work out of the box with the eslint extension installed. If this doe
}
```

<ArticleEditContent></ArticleEditContent>
<ArticleEditContent></ArticleEditContent>

0 comments on commit 7d62010

Please sign in to comment.