You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-18Lines changed: 11 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,40 +15,33 @@ Zachęcamy do otwierania Issues ze znalezionymi bugami i z sugestiami tego, co m
15
15
16
16
## Wymagania
17
17
18
-
-`yarn` w wersji co najmniej 1.22.x, ale mniejszej niż 2.x.x
19
-
- Docker i polecenie `docker-compose`
18
+
-`pnpm` w wersji co najmniej 7.17.0
19
+
- Docker i polecenie `dockercompose`
20
20
21
21
## Praca lokalna
22
22
23
23
Przed przystąpieniem do pracy należy skopiować plik `.env-sample` do `.env`.
24
-
Projekt uruchamiamy jednym poleceniem `yarn dev`. Spowoduje ono instalację wszystkich potrzebnych zależności, uruchomienie kontenera w Dockerze oraz naszej aplikacji.
24
+
Projekt uruchamiamy jednym poleceniem `pnpm dev`. Spowoduje ono instalację wszystkich potrzebnych zależności, uruchomienie kontenera w Dockerze oraz naszej aplikacji.
25
25
Po chwili powinna być gotowa pod adresem http://localhost:3000/
26
26
27
27
### Uwaga co do Supabase
28
28
29
-
Przy pierwszym uruchomieniu, możesz zobaczyć komunikat mówiąc o braku Supabase. W takim przypadku uruchom polecenie `yarn supabase init` i zatwierdź domyślne opcje wciskając 3xenter. Po dłuższej chwili na ekranie zobaczysz 5 wartości:
29
+
Przy pierwszym uruchomieniu, możesz zobaczyć komunikat mówiąc o braku Supabase. W takim przypadku uruchom polecenie `pnpm supabase init`. Następnie uruchom `pnpm supabase start`.
30
30
31
-
- Supabase URL
32
-
- Supabase Key (anon, public)
33
-
- Supabase Key (service_role, private)
34
-
- Database URL
35
-
- Email testing interface URL
31
+
Użyj komendy `pnpm supabase status`, aby uzyskać dostęp do wartości, które następnie musisz skopiować do swojego pliku `.env`. Odpowiednio:
36
32
37
-
Koniecznie skopiuj je do swojego pliku `.env` odpowiednio:
33
+
-`API URL` jako `NEXT_PUBLIC_SUPABASE_URL`
34
+
-`anon key` jako `NEXT_PUBLIC_SUPABASE_ANON_KEY`
35
+
-`DB URL` jako `DATABASE_URL` oraz `DATABASE_POOL_URL`
38
36
39
-
- Supabase URL jako `NEXT_PUBLIC_SUPABASE_URL`
40
-
- Supabase Key (anon, public) jako `NEXT_PUBLIC_SUPABASE_ANON_KEY`
41
-
- Database URL jako `DATABASE_URL` i `DATABASE_POOL_URL`
42
-
- Supabase Key (service_role, private) oraz Email testing interface URL nie będą potrzebne
43
-
44
-
Następnie ponownie odpal `yarn dev`.
37
+
Następnie odpal `pnpm dev`.
45
38
46
39
## Przywracanie danych z DUMP.sql
47
40
48
41
Gdy wszystko będzie już gotowe, to w drugim oknie terminala należy wpisać polecenie:
Spowoduje to załadowanie danych do bazy z pliku DUMP.sql.
@@ -57,6 +50,6 @@ Spowoduje to załadowanie danych do bazy z pliku DUMP.sql.
57
50
58
51
Większość konwencji w projekcie jest wymuszona przez `prettier` i/lub `eslint` oraz TypeScripta.
59
52
60
-
Ważna uwaga odnośnie tworzenia Pull Requestów: Od 29. grudnia korzystamy z "Conventional Commits", aby łatwiej nam było generować CHANGELOG. **Nazwy commitów mogą być dowolne**, ale **tytuł samego PR-a musi spełniać określone wymagania**! Więcej informacji oraz przykłady można znaleźć tutaj: https://highlab.pl/conventional-commits/
53
+
Ważna uwaga odnośnie tworzenia Pull Requestów: korzystamy z "Conventional Commits", aby łatwiej nam było generować CHANGELOG. **Nazwy commitów mogą być dowolne**, ale **tytuł samego PR-a musi spełniać określone wymagania**! Więcej informacji oraz przykłady można znaleźć tutaj: https://highlab.pl/conventional-commits/
61
54
62
55
**Tytuły i opisy PR-ów piszemy w języku polskim!**
0 commit comments