Created by Github action --------- Co-authored-by: github-actions <github-actions@twenty.com>
330 lines
8.8 KiB
Plaintext
330 lines
8.8 KiB
Plaintext
---
|
|
title: Local Setup
|
|
description: "Guiden för medverkande (eller nyfikna utvecklare) som vill köra Twenty lokalt."
|
|
image: /images/user-guide/fields/field.png
|
|
---
|
|
|
|
<Frame>
|
|
<img src="/images/user-guide/fields/field.png" alt="Header" />
|
|
</Frame>
|
|
|
|
## Nödvändiga förutsättningar
|
|
|
|
<Tabs>
|
|
<Tab title="Linux and MacOS">
|
|
|
|
Innan du kan installera och använda Twenty, se till att du installerar följande på din dator:
|
|
|
|
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
|
|
- [Node v24.5.0](https://nodejs.org/en/download)
|
|
- [yarn v4](https://yarnpkg.com/getting-started/install)
|
|
- [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md)
|
|
|
|
<Warning>
|
|
`npm` kommer inte att fungera, du bör använda `yarn` istället. Yarn levereras nu med Node.js, så du behöver inte installera det separat.
|
|
Du behöver bara köra `corepack enable` för att aktivera Yarn om du inte redan har gjort det.
|
|
</Warning>
|
|
|
|
</Tab>
|
|
|
|
<Tab title="Windows (WSL)">
|
|
|
|
1. Installera WSL
|
|
Öppna PowerShell som administratör och kör:
|
|
|
|
```powershell
|
|
wsl --install
|
|
```
|
|
|
|
Du bör nu se en uppmaning att starta om datorn. Om inte, starta om den manuellt.
|
|
|
|
Efter omstart öppnas ett PowerShell-fönster och Ubuntu installeras. Detta kan ta lite tid.
|
|
Du ser en uppmaning att skapa ett användarnamn och lösenord för din Ubuntu-installation.
|
|
|
|
2. Installera och konfigurera git
|
|
|
|
```bash
|
|
sudo apt-get install git
|
|
|
|
git config --global user.name "Your Name"
|
|
|
|
git config --global user.email "youremail@domain.com"
|
|
```
|
|
|
|
3. Installera nvm, node.js och yarn
|
|
|
|
<Warning>
|
|
Använd `nvm` för att installera rätt `node`-version. `.nvmrc` säkerställer att alla medverkande använder samma version.
|
|
</Warning>
|
|
|
|
```bash
|
|
sudo apt-get install curl
|
|
|
|
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
|
|
```
|
|
|
|
Stäng och öppna din terminal igen för att använda nvm. Kör sedan följande kommandon.
|
|
|
|
```bash
|
|
|
|
nvm install # installs recommended node version
|
|
|
|
nvm use # use recommended node version
|
|
|
|
corepack enable
|
|
```
|
|
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
---
|
|
|
|
## Step 1: Git Clone
|
|
|
|
I din terminal kör följande kommando.
|
|
|
|
<Tabs>
|
|
<Tab title="SSH (Recommended)">
|
|
Om du inte redan har ställt in SSH-nycklar kan du lära dig hur man gör det [här](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/about-ssh).
|
|
```bash
|
|
git clone git@github.com:twentyhq/twenty.git
|
|
```
|
|
</Tab>
|
|
<Tab title="HTTPS">
|
|
|
|
```bash
|
|
git clone https://github.com/twentyhq/twenty.git
|
|
```
|
|
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Step 2: Position yourself at the root
|
|
|
|
```bash
|
|
cd twenty
|
|
```
|
|
|
|
You should run all commands in the following steps from the root of the project.
|
|
|
|
## Steg 3: Ställ in en PostgreSQL-databas
|
|
|
|
<Tabs>
|
|
<Tab title="Linux">
|
|
**Option 1 (preferred):** To provision your database locally:
|
|
Use the following link to install Postgresql on your Linux machine: [Postgresql Installation](https://www.postgresql.org/download/linux/)
|
|
```bash
|
|
psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
|
|
```
|
|
Note: You might need to add `sudo -u postgres` to the command before `psql` to avoid permission errors.
|
|
|
|
````
|
|
**Option 2:** If you have docker installed:
|
|
```bash
|
|
make postgres-on-docker
|
|
```
|
|
````
|
|
|
|
</Tab>
|
|
<Tab title="Mac OS">
|
|
**Option 1 (preferred):** To provision your database locally with `brew`:
|
|
|
|
````
|
|
```bash
|
|
brew install postgresql@16
|
|
export PATH="/opt/homebrew/opt/postgresql@16/bin:$PATH"
|
|
brew services start postgresql@16
|
|
psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
|
|
```
|
|
|
|
You can verify if the PostgreSQL server is running by executing:
|
|
```bash
|
|
brew services list
|
|
```
|
|
|
|
The installer might not create the `postgres` user by default when installing
|
|
via Homebrew on MacOS. Instead, it creates a PostgreSQL role that matches your macOS
|
|
username (e.g., "john").
|
|
To check and create the `postgres` user if necessary, follow these steps:
|
|
```bash
|
|
# Connect to PostgreSQL
|
|
psql postgres
|
|
or
|
|
psql -U $(whoami) -d postgres
|
|
```
|
|
|
|
Once at the psql prompt (postgres=#), run:
|
|
```bash
|
|
# List existing PostgreSQL roles
|
|
\du
|
|
```
|
|
You'll see output similar to:
|
|
```bash
|
|
Role name | Attributes | Member of
|
|
-----------+-------------+-----------
|
|
john | Superuser | {}
|
|
```
|
|
|
|
If you do not see a `postgres` role listed, proceed to the next step.
|
|
Create the `postgres` role manually:
|
|
```bash
|
|
CREATE ROLE postgres WITH SUPERUSER LOGIN;
|
|
```
|
|
This creates a superuser role named `postgres` with login access.
|
|
|
|
**Option 2:** If you have docker installed:
|
|
```bash
|
|
make postgres-on-docker
|
|
```
|
|
````
|
|
|
|
</Tab>
|
|
<Tab title="Windows (WSL)">
|
|
All the following steps are to be run in the WSL terminal (within your virtual machine)
|
|
|
|
````
|
|
**Option 1:** To provision your Postgresql locally:
|
|
Use the following link to install Postgresql on your Linux virtual machine: [Postgresql Installation](https://www.postgresql.org/download/linux/)
|
|
```bash
|
|
psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
|
|
```
|
|
Note: You might need to add `sudo -u postgres` to the command before `psql` to avoid permission errors.
|
|
|
|
**Option 2:** If you have docker installed:
|
|
Running Docker on WSL adds an extra layer of complexity.
|
|
Only use this option if you are comfortable with the extra steps involved, including turning on [Docker Desktop WSL2](https://docs.docker.com/desktop/wsl).
|
|
```bash
|
|
make postgres-on-docker
|
|
```
|
|
````
|
|
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
Du kan nu komma åt databasen på [localhost:5432](localhost:5432), med användare `postgres` och lösenord `postgres`.
|
|
|
|
## Steg 4: Ställ in en Redis-databas (cache)
|
|
|
|
Twenty kräver en redis-cache för att ge bästa prestanda
|
|
|
|
<Tabs>
|
|
<Tab title="Linux">
|
|
**Option 1:** To provision your Redis locally:
|
|
Use the following link to install Redis on your Linux machine: [Redis Installation](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-linux/)
|
|
|
|
````
|
|
**Option 2:** If you have docker installed:
|
|
```bash
|
|
make redis-on-docker
|
|
```
|
|
````
|
|
|
|
</Tab>
|
|
<Tab title="Mac OS">
|
|
**Option 1 (preferred):** To provision your Redis locally with `brew`:
|
|
```bash
|
|
brew install redis
|
|
```
|
|
Start your redis server:
|
|
```brew services start redis```
|
|
|
|
````
|
|
**Option 2:** If you have docker installed:
|
|
```bash
|
|
make redis-on-docker
|
|
```
|
|
````
|
|
|
|
</Tab>
|
|
<Tab title="Windows (WSL)">
|
|
**Option 1:** To provision your Redis locally:
|
|
Use the following link to install Redis on your Linux virtual machine: [Redis Installation](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-linux/)
|
|
|
|
````
|
|
**Option 2:** If you have docker installed:
|
|
```bash
|
|
make redis-on-docker
|
|
```
|
|
````
|
|
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
Om du behöver en klient-GUI, rekommenderar vi [redis insight](https://redis.io/insight/) (gratisversion tillgänglig)
|
|
|
|
## Steg 5: Ställ in miljövariabler
|
|
|
|
Använd miljövariabler eller `.env`-filer för att konfigurera ditt projekt. Mer info [här](https://docs.twenty.com/l/sv/developers/self-hosting/setup)
|
|
|
|
Kopiera `.env.example`-filerna i `/front` och `/server`:
|
|
|
|
```bash
|
|
cp ./packages/twenty-front/.env.example ./packages/twenty-front/.env
|
|
cp ./packages/twenty-server/.env.example ./packages/twenty-server/.env
|
|
```
|
|
|
|
## Steg 6: Installera beroenden
|
|
|
|
To build Twenty server and seed some data into your database, run the following command:
|
|
|
|
```bash
|
|
yarn
|
|
```
|
|
|
|
Observera att `npm` eller `pnpm` inte fungerar
|
|
|
|
## Steg 7: Köra projektet
|
|
|
|
<Tabs>
|
|
<Tab title="Linux">
|
|
Beroende på din Linux-distribution, kan Redis-servern startas automatiskt.
|
|
Om inte, kolla [Redis installationsguide](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/) för din distro.
|
|
</Tab>
|
|
<Tab title="Mac OS">
|
|
Redis bör redan vara igång. If not, run:
|
|
```bash
|
|
brew services start redis
|
|
```
|
|
</Tab>
|
|
<Tab title="Windows (WSL)">
|
|
Beroende på din Linux-distribution, kan Redis-servern startas automatiskt.
|
|
Om inte, kolla [Redis installationsguide](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/) för din distro.
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
Konfigurera din databas med följande kommando:
|
|
|
|
```bash
|
|
npx nx database:reset twenty-server
|
|
```
|
|
|
|
Starta servern, arbetaren och frontend-tjänsterna:
|
|
|
|
```bash
|
|
npx nx start twenty-server
|
|
npx nx worker twenty-server
|
|
npx nx start twenty-front
|
|
```
|
|
|
|
Alternativt kan du starta alla tjänster samtidigt:
|
|
|
|
```bash
|
|
npx nx start
|
|
```
|
|
|
|
## Steg 8: Använd Twenty
|
|
|
|
**Frontend**
|
|
|
|
Twentys frontend kommer att köra på [http://localhost:3001](http://localhost:3001).
|
|
Du kan logga in med standarddemokontot: `tim@apple.dev` (lösenord: `tim@apple.dev`)
|
|
|
|
**Backend**
|
|
|
|
- Twentys server kommer att vara igång på [http://localhost:3000](http://localhost:3000)
|
|
- GraphQL-API:n kan nås på [http://localhost:3000/graphql](http://localhost:3000/graphql)
|
|
- REST-API:n kan nås på [http://localhost:3000/rest](http://localhost:3000/rest)
|
|
|
|
## Felsökning
|
|
|
|
Om du stöter på några problem, kolla [Felsökning](https://docs.twenty.com/l/sv/developers/self-hosting/troubleshooting) för lösningar. |