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

Revised contributing.md, edited docs (#1951)

Browse Source 
* Added Overview page

* Revised Getting Started page

* Minor revision

* Edited readme, minor modifications to docs

* Removed sweep.yaml, .devcontainer, .ergomake

* Moved security.md to .github, added contributing.md

* changes as per code review

* updated contributing.md

* fixed broken links & added missing links in doc, improved structure

* fixed link in wsl setup

* fixed server link, added https cloning in yarn-setup
This commit is contained in:
Nimra Ahmed
2023-10-10 15:33:17 +05:00
committed by GitHub
parent 017a0b1563
commit ae32a2da3b
23 changed files with 814 additions and 428 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/contributor/local-setup/yarn-setup.mdx
+24 -7
View File
@@ -7,8 +7,10 @@ sidebar_custom_props:
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
In this document, you'll learn how to install the project using yarn. We recommend this method since it's the easiest way to get started but you can also run the project with [Docker](/contributor/local-setup/docker-setup) or [WSL2](/contributor/local-setup/wsl-setup).
**Note:** `npm` currently does not support local packages satisfactorily. We strongly recommend using `yarn` instead.
> **Note:** `npm` currently does not support local packages satisfactorily. We strongly recommend using `yarn` instead.
## Prerequisites
@@ -16,22 +18,37 @@ Before you can install and use Twenty, make sure you install the following on yo
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- [Node](https://nodejs.org/en/download)
- [yarn](https://classic.yarnpkg.com/lang/en/docs/install/)
- [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md)
---
## Step #1: Git Clone
In your terminal, run the following command:
In your terminal, run the following command.
```
We recommend using SSH for this step. If you already haven't set up SSH keys, please do so first. You can learn more about it [here](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/about-ssh).
<Tabs>
<TabItem value="ssh" label="SSH (Recommended)" default>
```bash
git clone git@github.com:twentyhq/twenty.git
```
</TabItem>
<TabItem value="https" label="HTTPS (Not Recommended)" >
```bash
git clone https://github.com/twentyhq/twenty.git
```
</TabItem>
</Tabs>
## Step #2: Set up PostgreSQL Database
You need to have a PostgreSQL database available to be able to use Twenty. If you already have one available, you can skip this step.
If you don't, you can provision one through `docker` using the following commands:
If you don't, you can provision one through `docker`. With docker running, use the following commands:
<Tabs>
<TabItem value="docker" label="Docker" default>
@@ -102,7 +119,7 @@ cp ./server/.env.example ./server/.env
## Step #4: Server setup
**Note:** We recommend that you use `nvm` to install the correct `node` version. We have added a `server/.nvmrc` to ensure all contributors are using the same version.
> **Note:** We recommend that you use `nvm` to install the correct `node` version. We have added a `server/.nvmrc` to ensure all contributors use the same version.
To build Twenty server and seed some data into your database, run the following commands:
```bash
@@ -114,11 +131,11 @@ yarn prisma:reset
yarn start:dev
```
Twenty's server will be up and running at [http://localhost:3000](http://localhost:3000).
Twenty's server will be up and running at [http://localhost:3000/graphql](http://localhost:3000/graphql).
## Step #5: Frontend setup
**Note:** For the frontend setup, too, we recommend using `nvm` to install the right node version.
> **Note:** For the frontend setup, too, we recommend using `nvm` to install the right node version.
To set up the frontend, run the following commands in your terminal:
```bash