Skip to content

Commit

Permalink
docs: Aktualizacja CONTRIBUTING.md (#168)
Browse files Browse the repository at this point in the history
* docs: Aktualizacja CONTRIBUTING.md

* Fix tsc
  • Loading branch information
typeofweb committed Oct 9, 2021
1 parent 097b75e commit 5e37a79
Show file tree
Hide file tree
Showing 4 changed files with 543 additions and 275 deletions.
20 changes: 9 additions & 11 deletions .env-sample
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,31 @@ DATABASE_URL="postgres://postgres:postgres@localhost:5438/postgres"
DATABASE_POOL_URL="postgres://postgres:postgres@localhost:5438/postgres"
NEXT_PUBLIC_SUPABASE_URL="http://localhost:8765"
NEXT_PUBLIC_SUPABASE_ANON_KEY="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJzdXBhYmFzZSIsImlhdCI6MTYwMzk2ODgzNCwiZXhwIjoyNTUwNjUzNjM0LCJyb2xlIjoiYW5vbiJ9.36fUebxgx1mcBo4s19v0SzqmzunP--hm_hep0uLX0ew"
# Supabase Key (service_role, private): eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJzdXBhYmFzZSIsImlhdCI6MTYwMzk2ODgzNCwiZXhwIjoyNTUwNjUzNjM0LCJyb2xlIjoic2VydmljZV9yb2xlIn0.necIJaiP7X2T2QjGeV-FhpkizcNTX8HjDDBAxpgQTEI
# Email testing interface URL: http://localhost:9000

YOUTUBE_API_KEY=""
CLOUDINARY_URL=""

# Supabase Key (service_role, private): eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJzdXBhYmFzZSIsImlhdCI6MTYwMzk2ODgzNCwiZXhwIjoyNTUwNjUzNjM0LCJyb2xlIjoic2VydmljZV9yb2xlIn0.necIJaiP7X2T2QjGeV-FhpkizcNTX8HjDDBAxpgQTEI
# Email testing interface URL: http://localhost:9000

FEED_UPDATE_SECRET="supertajne"
CURSOR_ENCRYPTION_KEY="d6F3Efeqd6F3Efeq"

CAPTCHA_SECRET_KEY=0x0000000000000000000000000000000000000000
NEXT_PUBLIC_CAPTCHA_SITE_KEY=10000000-ffff-ffff-ffff-000000000001
NEXT_PUBLIC_URL="localhost:3000"

NEXT_PUBLIC_GA_TRACKING_ID=""
NEXT_PUBLIC_SENTRY_DSN=""

MAILGUN_DOMAIN="domena1337.mailgun.org"
MAILGUN_API_KEY="SekretnyKluczDoAPI"
MAILGUN_FROM="foo@bar.com"

NEXT_PUBLIC_GA_TRACKING_ID=""
NEXT_PUBLIC_SENTRY_DSN=""
NEXT_PUBLIC_CAPTCHA_SITE_KEY=10000000-ffff-ffff-ffff-000000000001
NEXT_PUBLIC_URL="localhost:3000"

GITHUB_ID="supertajne"
GITHUB_SECRET="bardzotajne"
SECRET="anothersecret"
JWT_SECRET="hmmmmmm"

NEXT_PUBLIC_ALGOLIA_API_KEY=""
ALGOLIA_API_SECRET=""
NEXT_PUBLIC_ALGOLIA_APP_ID=""
NEXT_PUBLIC_ALGOLIA_INDEX_NAME=""
ALGOLIA_API_SECRET=""
NEXT_PUBLIC_ALGOLIA_API_KEY=""
25 changes: 23 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Zachęcamy do otwierania Issues ze znalezionymi bugami i z sugestiami tego, co m

- TypeScript
- Next.js (SSG, ISG)
- PostgreSQL
- PostgreSQL (Supabase)
- Prisma
- Docker
- Vercel
Expand All @@ -24,10 +24,31 @@ Przed przystąpieniem do pracy należy skopiować plik `.env-sample` do `.env`.
Projekt uruchamiamy jednym poleceniem `yarn dev`. Spowoduje ono instalację wszystkich potrzebnych zależności, uruchomienie kontenera w Dockerze oraz naszej aplikacji.
Po chwili powinna być gotowa pod adresem http://localhost:3000/

### Uwaga co do Supabase

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:

- Supabase URL
- Supabase Key (anon, public)
- Supabase Key (service_role, private)
- Database URL
- Email testing interface URL

Koniecznie skopiuj je do swojego pliku `.env` odpowiednio:

- Supabase URL jako `NEXT_PUBLIC_SUPABASE_URL`
- Supabase Key (anon, public) jako `NEXT_PUBLIC_SUPABASE_ANON_KEY`
- Database URL jako `DATABASE_URL` i `DATABASE_POOL_URL`
- Supabase Key (service_role, private) oraz Email testing interface URL nie będą potrzebne

Następnie ponownie odpal `yarn dev`.

## Przywracanie danych z DUMP.sql

Gdy wszystko będzie już gotowe, to w drugim oknie terminala należy wpisać polecenie:

```bash
docker exec -i polskifrontend_typeofweb_polskifrontend_1 psql polskifrontend -U postgres < DUMP.sql
docker exec -i supabase-db psql postgres -U postgres < DUMP.sql
```

Spowoduje to załadowanie danych do bazy z pliku DUMP.sql.
Expand Down

0 comments on commit 5e37a79

Please sign in to comment.