Sklep Type of Web

Projekt edukacyjny. Licencja: AGPL

Uruchomienie

1. Aby uruchomić API będziesz potrzebować dockera (polecenie docker-compose musi być dostępne, port 5432 musi być wolny).
2. Skopiuj plik apps/api/.env-sample do apps/api/.env.
3. Uruchom frontend i backend jedną komendą yarn dev. Automatycznie zostaną zainstalowane też potrzebne zależności.
4. Do pliku /etc/hosts (lub c:\Windows\System32\Drivers\etc\hosts) dodaj dwie linijki:

127.0.0.1 api.sklep.localhost
127.0.0.1 www.sklep.localhost

5. Aplikacja będzie dostępna pod adresem http://www.sklep.localhost:3000/ a API pod http://api.sklep.localhost:3002/

6. Rejestracja nowego użytkownika w bazie danych:

• idź do http://api.sklep.localhost:3002/documentation#
• klikasz w POST ​/auth​/register
• następnie Try it out
• w:

{
  "email": "string",
  "password": "string"
}

wpisujesz dowolny adres e-mail oraz hasło, np:

{
  "email": "[email protected]",
  "password": "twoje_haslo1123"
}

pamiętaj by hasło nie było zbyt łatwe oraz aby adres e-mail był poprawny.

• klikasz w execute
• otwierasz nowy terminal i wpisujesz:

docker exec -it api_typeofweb_sklep_1 psql -U postgres

potem:

\c sklep

następnie:

UPDATE "User" SET role = 'ADMIN';

A na koniec: \q żeby wyjść

• otwierasz http://www.sklep.localhost:3000/admin/login aby się zalogować, jeżeli wszystko będzie w porządku to w prawym górnym rogu zobaczysz "Logowanie udane" i zostaniesz przekierowany na stronę http://www.sklep.localhost:3000/admin/products gdzie możesz dodawać produkty.

Jeśli będziesz chciał wyczyścić bazę danych to w folderze apps/api w terminalu wpisz docker-compose down

Zasady

Zarys architektury

Aplikacja dzieli się na 2 części:

1. Odpowiedzialną za zarządzanie produktami, dodawanie, edycję, ustalanie cen – nazwiemy ją Admin
2. Sklep z perspektywy klienta: przeglądanie produktów, dodawanie do koszyka, zakup – nazwiemy ją Klient

Stack

• Admin
  • API:
    • Node.js
    • Hapi
    • Prisma
    • PostgreSQL
    • TypeScript
  • WWW:
    • Next.js bez SSG ani SSR (nie potrzebujemy tego w Adminie)
    • ~React Hook Form do obsługi formularzy~ nie działało to zbyt dobrze z Carbon
    • React Final Form do obsługi formularzy
    • Carbon Design System (gotowe komponenty)
    • TypeScript
    • SCSS
• Klient
  • API:
    • To samo API, tylko inne endpointy
  • WWW:
    • Next.js z SSG do większości elementów.
      • Incremental Static Regeneration
      • ~Warto rozważyć bezpośrednie wbicie się do bazy z poziomu getStaticProps~
      • React Query dobrze działa z SSR
    • TypeScript
    • TailwindCSS
    • SCSS

Styleguide

• Strony (Pages)

export default function AdminHome() {
  return <div>AdminHome</div>;
}

• Komponenty

export const ProductList = React.memo<Props>((props) => {
  return <div>ProductList</div>;
});
ProductList.displayName = 'ProductList';

Współpraca

• Pracujemy w repo na branchach, których nazwy odpowiadają numerom tasków.
• Robimy pull requesty do brancha develop.

Tablica zadań

• https://github.com/typeofweb/sklep/projects/1