Skip to content

This is a project that I am working on. Our goal is clear. We want to host local reviews for businesses without bias or algorithms that hide honest reviews that often happen with other big corporation backed review websites.

Notifications You must be signed in to change notification settings

Tim-Quattrochi/Upfront-Local-Insights

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Upfront-Local-Insights

12/9/23 update: This app is now deployed on Vercel at : https://upfront-local-insights-client.vercel.app/

This project is deployed on an AWS EC2 instance and can be accessed by it's Public IPv4 address: http://54.90.137.205/ and also deployed on Vercel.


listings

Upfront Local Insights is a business review website that lets users rate and review businesses. Users can also submit a business (with Photo) if the business is not already listed.

The Problem

The problem I wanted to solve is simple. I want consumers to be able to write reviews, good or bad and have them seen. Consumers need full transparency. Both Google and Yelp! hide reviews.

Both Yelp! and Google hid reviews on a boarding facility I took our dog to. Had I seen those reviews I may have not taken her there. Our dog escaped this same facility and was hit by a car and injured. My review of this experience was even hidden.

Consumers have a right to know about any reviews being made about a business. My goal is to have a place where users can leave a review, and that review will be seen and not hidden by an algorithm, however, I do believe foul language and slander should be filtered.

Development

Upfront Local Insights requires Node.js v10+ to run. Tested on version 16.14.2

This App uses NPM Node Package Manager to manage it's dependencies and packages.

from the root directory

npm install

Create a .env file in the server folder and add your values.

For example:

 NODE_ENV=development
 DB_URI=YOUR_URI
 JWT_SECRET=YOUR_SECRET
 REFRESH_EXPIRES_IN=YOUR_VALUE DAYS, FOR EXAMPLE 20d
 REFRESH_TOKEN_SECRET=YOUR_SECRET
 PORT=3001

Double check your MongoDB connection URI. For example:

DB_URI=mongodb+srv://<username>:<password>@cluster0.qkyacex.mongodb.net/?retryWrites=true&w=majority

This App uses concurrently to start both the client and server. I have configured the root package.json to define workspaces with the client and server. So in the ROOT directory:

npm start

Tech Stack

Front-End


  • Vite - build tool that aims to provide a faster and leaner development experience for modern web projects.

  • React - JavaScript front end library.

  • Tailwind CSS - A utility-first CSS framework packed with classes like flex, pt-4, text-center and rotate-90 that can be composed to build any design, directly in your markup.

  • DaisyUI - It is simply a plugin for Tailwind CSS, which works on all frameworks and has made development faster, and customizable for developers using pure CSS.

Back-End


  • Mongoose - Mongoose is an object modeling tool for MongoDB and Node.js.

  • Node.js - cross-platform, open-source server environment that can run on Windows, Linux, Unix, macOS, and more. Node.js is a back-end JavaScript runtime environment, runs on the V8 JavaScript Engine, and executes JavaScript code outside a web browser.

  • Express - Express.js, or simply Express, is a back end web application framework for building RESTful APIs with Node.js

  • MongoDB - MongoDB Atlas is a fully managed cloud database service that allows you to easily deploy, scale, and operate MongoDB databases in the cloud.

Deployment tools


  • Nginx - Nginx is a web server that can also be used as a reverse proxy, load balancer, mail proxy and HTTP cache.

  • AWS EC2 - An EC2 instance is simply a virtual server in Amazon Web Services terminology. With an EC2 instance, AWS subscribers can request and provision a computer server within the AWS cloud.

  • PM2 - PM2 is a daemon process manager that will help you manage and keep your application online 24/7

Contributing


Find a bug? I welcome contributions. Simply open a pull request with your changes and I will review them.

About

This is a project that I am working on. Our goal is clear. We want to host local reviews for businesses without bias or algorithms that hide honest reviews that often happen with other big corporation backed review websites.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published