Bestbiz

Search and explore business listings.

Bestbiz is a Devcenter Project.

Feature List

• User can view listings.
• User can search listings through name and description.
• Authenticated user can create a listing for a business.
• New listing contains: business name, address, description, website url, categories, email and phone.
• Authenticated user can create multiple categories.
• A business listing can belong to multiple categories.
• Authenticated user can see how many views a business listing has had.
• Authenticated user can modify or delete a listing.
• Search API for listing name and description.

Getting Started

Bestbiz is hosted on Heroku and can be accessed here:

• Production

Search API:

Make a GET request via

https://bestbiz.herokuapp.com/api/search/?q=

• The value of q could be a listing name or description
• Output is in JavaScript Object Notation (JSON)

Example

The following example requests all listings that match the query 'payments' :

https://bestbiz.herokuapp.com/api/search/?q=payments

Prerequisites

These are what you need installed on your computer to use the application:

• Web Browser (Chrome, or Mozilla, or Safari, or Opera, or Microsoft Edge )

For Developers:

• Node.js
• Yarn
• MongoDb

Setup

Local Copy

To create a local copy, run the following in your terminal:

git clone https://github.com/ajibs/bestbiz.git

Then change into the local directory, run the following in your terminal:

cd bestbiz

Install Node.js and Yarn

If you don't have Node.js installed, please go ahead and grab it here. This project uses ES6+ features and requires Node version <=8.9.1

Yarn is a package manager for Node.js and can be installed from here.

To confirm that you have Node.js installed, run the following in your terminal:

node -v

You should get something like v8.9.1.

To confirm that you have Yarn installed, run the following in your terminal:

yarn -v

You should get something like 1.3.2.

Setup Database and .env file

You can setup a database on mlab. You should also create a .env file using .env.sample as a prototype.

Install Node.js Modules

To install all dependencies, run the following in your terminal:

yarn

Development

To kickstart the application, run the following in your terminal:

npm start

To continue full-stack development on this project, run the following in your terminal:

npm run dev

Built With

• Git - Version Control
• Node.js - JS Runtime Environment
• Yarn - Package Manager
• Express - Web Framework
• Pug - Templating Engine
• Webpack - Build Tool
• Babel - Transpiler
• Eslint - Linting Tool
• mLab - Database
• Heroku - Hosting and Continuous Deployment
• VS Code - Code Editor
• Chrome - Browser

Possible Features

• Change listing url to slugs
• Authenticated user can upload an image when creating a listing
• Pagination for pages with a lot of data to display e.g. explore page, dashboard

Author

• Bolu Ajibawo