evanigwilo / book-match Goto Github PK

Book Match is a web application equipped with the capability to match individuals' personalities with literature genres and specific books using vector algorithms.

The API has the functionality to create students, questions, and match specific genres of books based on users' answers to the questions.

The UI boasts an easy-to-use design that offers a straightforward graphical visual representation of the matching results.

This solution uses Node.js runtime, Express.js for the API layer, MongoDB for non-relational data, Tailwind CSS for styling, Puppeteer for web scraping using Chromium over the DevTools Protocol, and Next.js for the UI

You can explore the REST API

The web scraping tool leverages Puppeteer and headless browsing to automate the process of navigating to a webpage, extracting book details using selective DOM queries, and returning the information in a structured format.

This approach provides a robust and controlled mechanism for scraping data from the target website.

• Straightforwardness of visual representation of results
• Effective, efficient and useful book matching system
• Responsive web design
• Easy-to-use UI

• Next.js (+SSR)
• React
• Tailwind CSS
• Express.js
• MongoDB
• Puppeteer
• Redux Toolkit
• Axios
• Others...

Before getting started, make sure you have the following requirements:

• Docker
• Docker Compose (Supporting compose file version 3)
• Node.js (v16 or higher)
• Yarn Package Manager
• A bash compatible shell

Follow these steps to get your development environment set up:

1. Clone this repository locally;

# Change to the desired directory
$ cd <desired-directory>

# Clone the repo
$ git clone https://github.com/evanigwilo/book-match.git

# Change to the project directory
$ cd book-match

2. Change environmental variables file name in backend folder from .env.example to .env

3. Change environmental variables file name in frontend folder from .env.local.example to .env.local

4. Update the .env or .env.local file configuration values (optional)

5. At the root directory, run the following command to start a mongo database in a docker container

# Create external docker volume for the mongo development database
$ docker volume create book-match_mongo-db

# Build and run mongo database in a development container environment
$ docker-compose --env-file ./backend/.env -p book-match-dev-stack -f ./backend/docker-compose.yml up --build -d

6. At the root directory, run the following command to start the backed server

# Change to the project directory
$ cd backend

# Install dependencies
$ yarn install

#  Run app
$ yarn development

7. At the root directory, run the following command to start the web app

# Change to the project directory
$ cd frontend

# Install dependencies
$ yarn install

#  Run app
$ yarn dev

8. The web-app will be running at http://localhost:3000 and the api-server will be running at http://localhost:4000/v1

Note: When configuring Puppeteer, ensure that you adjust the 'executablePath' according to the actual installation path of Chrome on your system. This adjustment should be made in the environmental variable file within the backend.

Linux - /usr/bin/google-chrome
Mac - /Applications/Google Chrome.app/Contents/MacOS/Google Chrome
Windows - C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe

# Stops backend development containers and removes containers, networks and volumes
$ docker-compose --env-file ./backend/.env -p book-match-dev-stack -f ./backend/docker-compose.yml down --remove-orphans

# Removes the external docker volume for the mongo database
$ docker volume rm book-match_mongo-db

Next.js Documentation - learn about Next.js features and API.

Puppeteer

MongoDB

Redux Toolkit

Tailwind CSS

Swagger: API Documentation & Design Tools for Teams