Created by Github action --------- Co-authored-by: github-actions <github-actions@twenty.com>
330 lines
9.2 KiB
Plaintext
330 lines
9.2 KiB
Plaintext
---
|
|
title: Lokalna konfiguracja
|
|
description: "Przewodnik dla współautorów (lub ciekawych deweloperów), którzy chcą uruchomić Twenty lokalnie."
|
|
image: /images/user-guide/fields/field.png
|
|
---
|
|
|
|
<Frame>
|
|
<img src="/images/user-guide/fields/field.png" alt="Header" />
|
|
</Frame>
|
|
|
|
## Wymagania wstępne
|
|
|
|
<Tabs>
|
|
<Tab title="Linux and MacOS">
|
|
|
|
Zanim zainstalujesz i użyjesz Twenty, upewnij się, że na Twoim komputerze są zainstalowane następujące programy:
|
|
|
|
- [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` nie zadziała, zamiast tego należy użyć `yarn`. Yarn jest teraz dostarczany z Node.js, więc nie trzeba go instalować oddzielnie.
|
|
Musisz tylko uruchomić `corepack enable`, aby włączyć Yarn, jeśli jeszcze tego nie zrobiłeś.
|
|
</Warning>
|
|
|
|
</Tab>
|
|
|
|
<Tab title="Windows (WSL)">
|
|
|
|
1. Zainstaluj WSL
|
|
Otwórz PowerShell jako Administrator i uruchom:
|
|
|
|
```powershell
|
|
wsl --install
|
|
```
|
|
|
|
Teraz powinien pojawić się monit o ponowne uruchomienie komputera. Jeśli nie, uruchom go ręcznie.
|
|
|
|
Po ponownym uruchomieniu otworzy się okno PowerShell i zainstaluje Ubuntu. Może to zająć trochę czasu.
|
|
Zobaczysz monit o utworzenie nazwy użytkownika i hasła dla instalacji Ubuntu.
|
|
|
|
2. Zainstalować i skonfigurować git
|
|
|
|
```bash
|
|
sudo apt-get install git
|
|
|
|
git config --global user.name "Your Name"
|
|
|
|
git config --global user.email "youremail@domain.com"
|
|
```
|
|
|
|
3. Zainstaluj nvm, node.js i yarn
|
|
|
|
<Warning>
|
|
Użyj `nvm`, aby zainstalować poprawną wersję `node`. `.nvmrc` gwarantuje, że wszyscy współautorzy używają tej samej wersji.
|
|
</Warning>
|
|
|
|
```bash
|
|
sudo apt-get install curl
|
|
|
|
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
|
|
```
|
|
|
|
Zamknij i ponownie otwórz terminal, aby użyć nvm. Następnie uruchom następujące polecenia.
|
|
|
|
```bash
|
|
|
|
nvm install # installs recommended node version
|
|
|
|
nvm use # use recommended node version
|
|
|
|
corepack enable
|
|
```
|
|
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
---
|
|
|
|
## Krok 1: Git Clone
|
|
|
|
W terminalu uruchom następujące polecenie.
|
|
|
|
<Tabs>
|
|
<Tab title="SSH (Recommended)">
|
|
Jeśli jeszcze nie skonfigurowałeś kluczy SSH, możesz dowiedzieć się, jak to zrobić [tutaj](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>
|
|
|
|
## Krok 2: Ustaw się w katalogu głównym
|
|
|
|
```bash
|
|
cd twenty
|
|
```
|
|
|
|
Powinieneś uruchamiać wszystkie polecenia w kolejnych krokach z katalogu głównego projektu.
|
|
|
|
## Krok 3: Skonfiguruj bazę danych PostgreSQL
|
|
|
|
<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>
|
|
|
|
Teraz możesz uzyskać dostęp do bazy danych pod adresem [localhost:5432](localhost:5432), z użytkownikiem `postgres` i hasłem `postgres` .
|
|
|
|
## Krok 4: Skonfiguruj bazę danych Redis (cache)
|
|
|
|
Twenty wymaga pamięci cache redis, aby zapewnić najlepszą wydajność
|
|
|
|
<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>
|
|
|
|
If you need a Client GUI, we recommend [redis insight](https://redis.io/insight/) (free version available)
|
|
|
|
## Krok 5: Skonfiguruj zmienne środowiskowe
|
|
|
|
Użyj zmiennych środowiskowych lub plików `.env`, aby skonfigurować swój projekt. Więcej informacji [tutaj](https://docs.twenty.com/l/pl/developers/self-hosting/setup)
|
|
|
|
Skopiuj pliki `.env.example` w `/front` i `/server`:
|
|
|
|
```bash
|
|
cp ./packages/twenty-front/.env.example ./packages/twenty-front/.env
|
|
cp ./packages/twenty-server/.env.example ./packages/twenty-server/.env
|
|
```
|
|
|
|
## Krok 6: Instalacja zależności
|
|
|
|
Aby zbudować serwer Twenty i wprowadzić pewne dane do swojej bazy danych, uruchom następujące polecenie:
|
|
|
|
```bash
|
|
yarn
|
|
```
|
|
|
|
Zauważ, że `npm` lub `pnpm` nie będą działać
|
|
|
|
## Krok 7: Uruchamianie projektu
|
|
|
|
<Tabs>
|
|
<Tab title="Linux">
|
|
W zależności od Twojej dystrybucji Linuksa, serwer Redis może zostać uruchomiony automatycznie.
|
|
Jeśli nie, sprawdź [przewodnik instalacji Redis](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/) dla swojej dystrybucji.
|
|
</Tab>
|
|
<Tab title="Mac OS">
|
|
Redis powinien już działać. If not, run:
|
|
```bash
|
|
brew services start redis
|
|
```
|
|
</Tab>
|
|
<Tab title="Windows (WSL)">
|
|
W zależności od Twojej dystrybucji Linuksa, serwer Redis może zostać uruchomiony automatycznie.
|
|
Jeśli nie, sprawdź [przewodnik instalacji Redis](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/) dla swojej dystrybucji.
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
Skonfiguruj swoją bazę danych za pomocą następującego polecenia:
|
|
|
|
```bash
|
|
npx nx database:reset twenty-server
|
|
```
|
|
|
|
Uruchom serwer, pracownika i usługi frontendowe:
|
|
|
|
```bash
|
|
npx nx start twenty-server
|
|
npx nx worker twenty-server
|
|
npx nx start twenty-front
|
|
```
|
|
|
|
Alternatywnie, możesz uruchomić wszystkie usługi jednocześnie:
|
|
|
|
```bash
|
|
npx nx start
|
|
```
|
|
|
|
## Krok 8: Użyj Twenty
|
|
|
|
**Frontend**
|
|
|
|
Frontend Twenty będzie działał pod adresem [http://localhost:3001](http://localhost:3001).
|
|
Możesz zalogować się, używając domyślnego konta demo: `tim@apple.dev` (hasło: `tim@apple.dev`)
|
|
|
|
**Backend**
|
|
|
|
- Serwer Twenty będzie działać pod adresem [http://localhost:3000](http://localhost:3000)
|
|
- API GraphQL można uzyskać pod adresem [http://localhost:3000/graphql](http://localhost:3000/graphql)
|
|
- API REST można uzyskać pod adresem [http://localhost:3000/rest](http://localhost:3000/rest)
|
|
|
|
## Rozwiązywanie problemów
|
|
|
|
Jeśli napotkasz jakiekolwiek problemy, sprawdź [Rozwiązywanie problemów](https://docs.twenty.com/l/pl/developers/self-hosting/troubleshooting) w poszukiwaniu rozwiązań. |