basicyelp app

Project Overview

Introduction

this is a portfolio project I wrote to streighthen my knowledge as a full stack engineer. The goal of the project is to showcase all previews skills and technologies learned until this point on the path software engineer at CodeCademy. It is a PERN app that allows the user to post a new restaurant with the price range and at the same time customers can review restaurants they visited.

Project Requirements

• Build the application using Postgres, ExpressJS, NodeJs and React.

• Version controling the application with Git and host the repository on GitHub

• Use Github as project management tool to plan the work

• Write a README (using Markdown) that documents the project including:

  • Wireframes
  • Technologies used
  • Features
  • Future work

• Write unit tests for your components using Jest and Enzyme

• Write end-to-end tests for the application

• Users can use the application on any device (desktop to mobile)

• Users can use the application on any modern browser

• Users can access your application at a URL

• Users see an initial view of the data when first visiting the app

• Users can click on restaurant and end up on a specific restaurant page

• Each restaurant page allow to update the restaurant

• Users can add reviews through the restaurant review page

• OPTIONAL: Get a custom domain name and use it for the application

• OPTIONAL: Set up a CI/CD workflow to automatically deploy your application when the master branch in the repository changes

• OPTIONAL: Make the application a progressive web app

Project Links

• Repository: https://github.com/Yannickdjoa/basicyelp
• Live webpage: https://basicyelp.netlify.app/

Wireframes

Technologies used

The Project is mainly build using Javascript language with some additional languages necessary for React app such as JSX, Html and CSS.

• React.JS - JavaScript user interface library
• Html - structured languange
• CSS - language for the designing
• VScode - code editor
• Jest - JavaScript testing framework
• React Testing Library - React testing utility
• Netlify - live deployment tool

Features

Features will be add as my knowledge and practice of the front-end and backend will improve. First wave features will include:

• Main page: listing of all restaurants
• Possibility to delete a restaurant
• possibility to to update a restaurant
• Ability to interact with restaurant by reviewing each restaurant
• Page with the Overview of all reviews of each restaurant with form to submit a review
• Page for each restaurant with the possibility to update

Author

• Github: https://github.com/Yannickdjoa
• Webpage:
• Tweeter: https://twitter.com/DjoaYannick
• LinkedIn: https://www.linkedin.com/in/yannick-djoa-4319a317/

Roadmap

• Wave 1: current developed features (see features)
• Wave 2: additional features
  • Ability to add restaurant menu pictures
  • possibility to refer a restaurant
  • others