Skip to content

Yndh/FamiLynk

Repository files navigation

🏠 FamiLynk - Organizer Domowy

FamiLynk to aplikacja webowa stworzona w Next.js z TypeScript, która pomaga w organizacji życia rodzinnego. Aplikacja pozwala na dzielenie się z innymi członkami rodziny różnymi informacjami, takimi jak kalendarz, notatki, obowiązki i przepisy.

strona: https://hakhiros.vercel.app

Spis Treści

Funkcje

Aplikacja FamiLynk oferuje następujące funkcje:

  • Domy: W FamiLynk to grupy lub przestrzenie organizacyjne, które pozwalają na wspólne zarządzanie życiem rodzinym. Możesz utworzyć swój własny 'Dom' dla swojej rodziny lub dołączyć do istniejącego, aby wspólnie planować, organizować i zarządzać obowiązkami oraz wydarzeniami. Domy pozwalają na spersonalizowanie aplikacji pod potrzeby różnych grup rodzinnych. Chcąc zaprosić innych członków rodziny udostępniając im link do dołączenia do 'Domu' lub podać im kod QR.
  • Kalendarz: Możesz dodawać i zaplanować ważne wydarzenia, by każdy członek rodziny nie czuł się zaskoczony.
  • Notatki: Twórz notatki, które są dostępne dla wszystkich członków rodziny, żeby dać informacje członkom domu np. (lista zakupów, co zabrać na wyjazd, itd...).
  • Obowiązki: Przypisuj obowiązki domowe na konkretny dzień tygodnia dla wybranych użytkowników, aby nikt nie zapomniał o tym co miał zrobić.
  • Przepisy: Wybieraj i przygotowuj dania z listy przepisów kulinarnych. Masz tam opisaną listę składników, kroki przygotowania, poziom trudności i czas przygotowania posiłku.

Technologie i Biblioteki

Aplikacja FamiLynk została zbudowana przy użyciu kluczowych technologii i bibliotek:

  • Next.js: Framework React do renderowania na serwerze.
  • TypeScript: Rozszerza JavaScript o typy, co pomaga w większej pewności kodu.
  • Prisma: ORM do interakcji z bazą danych.
  • next-auth: Zapewnia mechanizmy autentykacji i zarządzania sesjami.
  • FontAwesome: Dostarcza ikony do użycia w aplikacji.
  • FullCalendar: Biblioteka do obsługi kalendarza.
  • bcrypt: Służy do haszowania haseł użytkowników.
  • react-qr-code: Umożliwia generowanie kodów QR.
  • react-toastify: Wyświetla powiadomienia w aplikacji.
  • dockera: konteneryzacja aplikacji

Instalacja

  1. Sklonuj repozytorium:
$ git clone https://github.com/Yndh/hakhiros.git
$ cd hakhiros
  1. Zainstaluj dockera

  2. Uruchom aplikację

  • bez hot-reload'a
$ docker compose up --build
  • z hot-reload'en
docker compose watch

Użycie

  1. Zarejestruj się lub zaloguj się w aplikacji.
  2. Utwórz nową rodzinę lub dołącz do istniejącej.
  3. Korzystaj z różnych modułów aplikacji, takich jak kalendarz, notatki, obowiązki i przepisy.

Autorzy

Yndh Qłesuga JerzT IB2R5

About

FamiLynk to aplikacja webowa stworzona w Next.js z TypeScript, która pomaga w organizacji życia rodzinnego. Aplikacja pozwala na dzielenie się z innymi członkami rodziny różnymi informacjami, takimi jak kalendarz, notatki, obowiązki i przepisy.

Resources

Stars

Watchers

Forks

Contributors

Languages