README.md

Link: https://express-companies-7fb42d417542.herokuapp.com/

Założenia projektu

Aplikacja internetowa służąca do dodawania i wyszukiwania firm.

Stos technologiczny

Front-end:

• ejs jako view engine

Back-end:

• Express.js jako framework do Node.js
• MongoDB jako baza danych w projekcie
• nodemon w celu restartowanai serwera po każdym odświerzeniu pliku
• bcrypt do hashowania haseł
• cookie-parser do parsowania cookie
• dotenv w celu wykorzystania pliku .env
• helmet w celu zwiększenia zabezpieczeń serwisu
• json2csv w celu generowania pliku csv
• mongoose dla zarządzania bazą danych MongoDB
• rate-limiter-flexible w celu zabezpieczenia prób dostępu do serwisu
• multer do przetwarzania danych wejscowych formularzy

Uwierzytelnianie:

• uwierzytelnianie za pomocą sesji

Inne:

• ESLint do statycznej analizy kodu i utrzymania jednolitej jakości kodu

Usługi chmurowe użyte w projekcie

MongoDB Cloud Services

Do przechowywania danych w bazie danych została użyta platforma MongoDB Atlas.

Zdjęcia poglądowe

Instrukcja instalacji projektu

Pobieramy projekt na lokalne środowisko. Tworzymy plik .env i kopiujemy do niego zawartość .env.example, po czym definiujemy swoje własne klucze API i dane konfiguracyjne.

Instalujemy npm za pomocą komendy:

npm install

Uruchamiamy aplikacje na lokalnym środowisku:

npm run watch

Domyśnie, jeżeli ustawimy port na 3000 w .env albo nie uswawimy go wcale, aplikacja powinna być dostępna na adresie http://localhost:3000. Adres wklejamy do przeglądarki internetowej.