daresTheDevil/advisr-applicant-project

Advisr Applicant Project

About The Project

VueJS client connect to Node/Express API. User can autocomplete search for businesses, sort by columns, and click business name to view details.

Project Scope

This project uses a Node/Express API to return data from a json file. A Vue client consumes these API endpoints to show data to the user. Search/filter is provided for loaded businesses as well as column level sorting indicated by an icon.

Selecting a business will load business details including a LeafletJS map with the business location indicated with a marker.

Quickstart

If you already have Docker and Git:

# clone the project
git clone https://github.com/davidbkay/advisr-applicant-project.git
# change to project directory
cd advisr-applicant-project
# start the project in docker
docker-compose up

Open your browser to http://localhost:8080.

Built With

• VueJS
• ViteJS
• NodeJS
• ExpressJS
• TailwindCSS
• LeafletJS
• Docker

Deploy to local k8s cluster

install Minikube with by following instructions at https://minikube.sigs.k8s.io/docs/start/

# start minikube cluster
minikube start
# open your dashboard
minikube dashboard
# in another terminal window, create services and deployments by using all files in ./k8s directory
kubectl apply -f ./k8s
# expose load balancer
minikube tunnel

open your browser to http://localhost:8080 to view the app

Run in terminal

Make sure you have NodeJS installed and open your terminal to the project root.

Start API in /server directory:

# install dependencies
npm install
# start API
npm start

Start Vue in /client directory:

# install dependencies
npm install
# in 'client' directory, start vue client with
npm run dev

Open your browser to http://localhost:3000.

To view API documentation in /docs directory:

# install dependencies
npm install
# view docs
npx serve

API Reference

Get all businesses

  GET /businesses

Get single business

  GET /business/:id

Parameter	Type	Description
id	string	Required. Id of business to fetch