Skip to content

Home

Jump to bottom
Ethan Browning edited this page Aug 25, 2022 · 6 revisions

Welcome to the PipCamp-Capstone wiki!

PipCamp is a HipCamp-ish clone where users can add and review locations from their favorite fallout games

PipCamp README

Welcome to the README for PipCamp! Live Link https://pip-camp.herokuapp.com

Index

  • Features

  • Components

  • Schema

  • Frontend Routes

  • API Routes

  • Screenshots

  • Install Pipcamp

  • Technologies

  • Planned Features

  • Technical Implementation Details

Features

Sign Up

Users can login and create an account. Any locations or reviews they make will be stored under their information

Navigation Bar

A navigation component is always visible anywhere on the application for quick and easy browsing to any view.

Demo User

A convenient Demo User button is available for users who may not wish to create an account

Locations

Users may browse all locations on the site on the main page, and click their respective cards to view details and reviews on the location. Users can upload their images to AWS instead of just providing a URL

Reviews

Users are able to leave a review for a location and leave their recommendation(yes/no). Each user can make 1 review per location

Favorites

Users are able to mark a location as a favorite, and see it and delete it on location and their user profile

Reservations

Users are able to make a faux-reservation at an in-game location, and see it and delete it on their user profile

Components

  • Locations: Locations, LocationPage, LocationForm, EditLocationForm
  • Reviews: Reviews(on LocationPage), ReviewForm, EditReviewForm
  • Favorites
  • Reservations
  • User
  • Footer
  • NavBar

Database Schema

Database Schema

API Routes

All routes begin with /api/

/auth

  • GET / - Authenticate user
  • POST /login - log user in
  • POST /logout - log user out
  • POST /sign_up - create new user instance and log them in

/locations

  • GET /new-location - Get new location form
  • POST /new-location - Submit new location form
  • GET /:locationId - Get details for a specific location
  • DELETE /:locationId/delete - Delete a specified location
  • PUT /:locationId/edit - Update a location's details

/reviews

  • GET /all - Get all reviews
  • POST /new - Post a new review
  • PUT /:reviewId/edit - update a review
  • DELETE /:reviewId/delete - delete a review

/users

  • GET /:userId - get logged in user's details

Redux Store Tree

/favorites

  • GET /:userId- Get all favorites for user
  • POST /new/favorite - Post a new favorite
  • DELETE /:favoriteId/delete - delete a favorite

/reservations

  • GET /:userId- Get all reservations for user
  • POST /new/reservation - Post a new review
  • DELETE /:reservationId/delete - delete a review

Installation

  1. Clone PipCamP
  2. cd into the /app folder.
  3. run pipenv install and enter your pipenv shell
  4. run flask run to start the backend flask server on default: port 3000
  5. In a seperate terminal, cd into the /react-app folder
  6. run npm install
  7. run npm build to start the frontend react server on default port: 5000 in production mode
  8. If it does not automatically open a browser window, navigate to localhost:5000 to access the app.

Technologies Used

Technical Details

PipCamp was built using Flask as its backend, and React / Redux for its front end.

Great care was put into making a visual clone that applies a different 'brand' with the original format. I used colors common to Fallout 4 to hopefully achieve an appropriate theme with the 'bones' of HipCamp.

Planned Features

  • Fallout Locations are all existing US cities: using google maps api, users can pin the real-world city where the in-game loction can be found
  • Location recommendation rate will appear as a statistic at the top of location details

Screenshots

Locations

Locations/Splash

Location Page

Location-top

Reviews

Clone this wiki locally