mariuszrudnik/myfinance-fe

📔 Spis treści

• Wstęp
• Opis projektu
  • Screenshoty
  • Zastosowane technologie
  • Funkcjonalności
  • Konfiguracja projektu
  • Kolorystyka
• Uruchomienie projektu
  • Instalacja
  • Uruchomienie lokalne
• Przeznaczenie projektu
• Endpointy
• Przyszłe aktualizacje
• Licencja
• Backend

📌 Wstęp

MyFinances to projekt powstały z chęci stworzenia aplikacji, której sam potrzebowałem oraz z której chętnie będę korzystać. Aplikacja służy do zapisywania wydatków, dodawania ich do odpowiednich kategorii i analizy poniesionych wydatków.

📷 Screenshoty

👾 Zastosowane technologie

Strona klienta

• Typescript
• React.js

Użyte paczki

• Redux
• React Router
• Formik
• Storybook
• Styled Components
• i18next React
• Lodash
• JSON Server
• React-Toastify
• React Query
• Downshift
• Axios

Strona serwera

• Typescript
• Nest.js

Użyte paczki po stronie serwera

• TypeOrm
• Swagger

Baza danych

• MySQL

🎨 Kolorystyka

Color	Hex
Primary Color	#3455F7FF
Secondary Color	#6B7A99
Accent Color	#F7F8FA
Text Color	#6B7A99

🎯 Funkcjonalności

• Rejestrowanie użytkowników
• Zaimplementowanie autoryzacji i autentykacji przy użyciu JWT
• Dodawanie portfeli, do których można dodawać wydatki i przychody
• Zaimplementowany wykres z wydatkami i przychodami
• Dodawani kategorii i podkategorii wydatków i przychodów

🔑 Konfiguracja projektu

W celu prawidłowego skonfigurowania projektu i połączenia z bazą danych, należy odpowiednio wypełnić pola w zmiennej lokalnej znajdującej się w pliku ormconfig.ts

🧰 Uruchomienie projektu

W tym projekcie domyślnym menadżerem paczek jest NPM.

⚙️ Instalacja

W katalogu projektu zainstaluj niezbędne zależności i paczki za pomocą komendy:

  npm install

🏃 Uruchomienie lokalne

Uruchomienie aplikacji

  npm start

Zbudowanie wersji produkcyjnej aplikacji

  npm run build

👀 Przeznaczenie projektu

Aplikacja pozwala w prosty sposób na dodawanie wydatków i przychodów oraz ich analizę.

🧭 Przyszłe aktualizacje

• widok RWD
• poprawienie dark mode
• poprawienie polskiej wersji językowej
• dodanie brakujących wykresów
• naprawa błędów
• PWA
• dodanie testów jednostkowych i integracyjnych
• zoptymalizowanie aplikacji

⚠️ Licencja

Distributed under the no License. See LICENSE.txt for more information.

🔻 Backend

Readme