Skip to content

A guide to the best of New York - for tourists by New Yorkers.

Notifications You must be signed in to change notification settings

eloisebarrow/seeNYC

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project Overview

Contributors

Eloise Barrow
Jad Izzedin
AJ Jernigan

Project Links

View Github Repo
View deployed site
Read my perspective on our process

Project Description

seeNYC is a concierge app that is built for tourists by New Yorkers. Users can browse a curated list of the best restaurants and sites according to locals. They also have the option to create an account, save their favorites to a personal list and rate destinations.

Installation Instructions

Type the following into the command line in the project's root folder:

npm i body-parser cors express morgan sequelize pg bcrypt jsonwebtoken nodemon

Type the following inside the client folder:

npm i axios react-router-dom

Technologies Used

React
Express.js
Postgres
Sequelize
Body-parser
CORS
Bcrypt
JSON Web Token
Nodemon
Morgan
react-router-dom
axios

API Description

We'll be building out a unique, RESTful API using Postgres, Sequelize and Express.

The API will include four models - destinations, users, user_favorites and ratings.

The destinations model will hold at least 30 unique restaurants/sites with the following data for each: name, borough, address, website, description, type (food or fun) and latitude/longitude coordinates.

The users model will hold all users who sign up for an account; data included will be a username (which will be their email address), nickname and a password_digest.

User_favorites will connect each user with the locations they've added to their favorites and the ratings model will have a column for ratings 1 through 5.

User Stories

Who are our users? What do they want? Why?

User 1: Individual comes to New York on vacation looking for things to do. They open the app to browse, decide they like what they see - create an account and make a list of favorites that they want to check out.

User 2: Local wants to find new places to check out, browses through the site and creates an account to save their list. They rate places they've been to and update ratings for places they revisit.

MVP (Minimum Viable Product)

  • Database populated with restaurant/site data, and empty user and user_favorites models
  • Express web server that hosts database
  • Landing page with header, main, footer
  • Render all restaurant data
  • Render all site data
  • Render individual destination data
  • Render star ratings for each destination and allow for setting and updating of those ratings

PostMVP

  • Reset password functionality
  • Attach a map to individual destination pages
  • Additional site/restaurant data

Wireframes

ERD

React Architecture

Additional Libraries

Issues and Resolutions

ERROR: Data would not generate from our seed file, error read "Cannot read property length of undefined"
RESOLUTION: We had to import the data in its own variable instead of through object destructuring.

About

A guide to the best of New York - for tourists by New Yorkers.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published