Skip to content

Latest commit

 

History

History
276 lines (175 loc) · 15.9 KB

README.md

File metadata and controls

276 lines (175 loc) · 15.9 KB

PrePacker

PrePacker Logo

Description

This MERN stack app is a tool aimed at backpackers looking to plan what they want to bring on their next trip. Users are able to keep track of key details about what gear they own, create PrePacker checklists that include the total weight of their bags, and use the lists to help them pack. This is mainly aimed at backpackers, but could be used for any trip, or simply to digitally store information about equipment.

You can check out the app here. It was deployed on Netlify for the frontend and Adaptable for the backend.

Why?

Packing for a trip can be stressful, so why not make it easier? With PrePacker, you will know:

  • exactly what you need to bring so you don't forget any essential items
  • how much everything weighs so you can efficiently find ways to lighten your load
  • what you brought on previous trips for quick reference
  • what did and didn't work by keeping notes in the app

PrePacker is your go-to solution for seamless, stress-free trip preparation.

Table of Contents

Demonstrations

There are three main pages: the closet, the checklist creator, and the saved lists page. On the closet page, users can see all the equipment they have uploaded with more detail compared to the PrePacker page including price, weight, personal notes, and links to where they bought the items. Here they can upload (manually or with a web scraper) and edit information about their gear. The checklist creator page is where users select gear to make a custom checklist for their trips and see how much their pack will weigh. Users can save these lists and access them on the saved lists page.

These features can be seen in action below.

Adding New Gear

Here is an example of a user adding new gear to their closet:

Example User Adding Gear

Using the Web Scraper to Add New Gear

Here is an example of the scraper in use. Any data found at the REI web address provided will be added to the fields. If data is not found for a specific field, it will be left blank. I may allow the user to scrape data from other websites in the future:

Example Scraping

Creating a New Checklist

Here is an example of a user creating a new checklist. You can see new items being added and removed, the total weight being updated, and the list being saved:

Example Create Checklist

The latest version also includes water and food weight.

Saved Lists

A condensed version of each list is shown on the saved lists page. The user can view all their saved lists, edit the lists, delete, and 'save as' to create a copy of a list:

Example of Saved List

Landing Page

New users will be greeted with a landing page that describes what the app can do:

Example of the Landing Page 1 Example of the Landing Page 2

Other Features

  • When deleting a piece of gear from their closet, the user will be notified if the gear is being used in any lists. If they choose to delete a piece of gear that is in a list, the gear will be removed from that list.
  • All lists and gear can be searched, edited, and deleted.

Example of searching and sorting the gear:

Searching and Sorting the Gear

Example of the gear editor and delete windows:

Example of the gear editor and delete windows

Notes

MongoDB and Mongoose

I have three Mongoose models:

const userSchema = new Schema({
  email: {
    type: String,
    required: true,
    unique: true
  },
  password: {
    type: String,
    required: true
  }
})

const gearSchema = new Schema({
  gear_name: { type: String, required: true },
  weight: Number,
  price: Number,
  category: { type: String, required: true },
  notes: String,
  website: Schema.Types.Mixed,
  image_url: Schema.Types.Mixed, //Saved for future use
  user_id: { type: String, required: true }
}, { timestamps: true })

const checklistSchema = new Schema({
  checklist_name: { type: String, required: true },
  gear_items: [String], // Array of _id's
  water_weight: Number, // in lb
  food_weight: Number, // in lb
  checklist_notes: String,
  user_id: { type: String, required: true }
}, { timestamps: true })

The checklistSchema contains a gear_items property that is an array of gearSchema IDs - rather than duplicating the gear data for every checklist, it made more sense to just reference it. The total weight of the list is calculated on the frontend.

The gearSchema and checklistSchema both reference the userSchema via a user_id property. It is still unclear to me if there is any downside to using this relational database over Mongoose subdocuments. Is doing it this way causing any security or performance issues?

Controllers and Routing

The controlling and routing is fairly simple - I mostly just needed to be able to talk with MongoDB. The most complicated thing was the web scrapper, which is discussed below.

Web Scraping

The frontend sends the url to the backend which uses cheerio and axios to grab any relevant data from an REI page. The REI product pages are mostly similar, but there are usually multiple options for data such as weight, price, and category. In these cases I would grab the first one found. Users are expected to confirm the information is correct - perhaps a warning should be placed.

If I allow for users to scrape from another website in the future, I will need to make sure the website has consistent product pages - I'm a little worried that Amazon's format would be a little too unpredictable for getting accurate gear data.

Originally I planned to scrape image urls and use those as images next to the gear data. This looked really nice, however I soon realized that this would likely be a copyright violation, so I scrapped the idea. I may allow users to upload their own images in the future and host them on Imgur like I did with my Hiker Tracker App.

The web scraper didn't work after deploying it. This was because of CORS. I had to run it through a proxy server in order to get it to work again. The first proxy, crossorigin.me, ended up not working - I think it might be out of date. I'm using the free tier of scraperapi now, but you only get 1000 free calls. The lowest tier pricing is $49/month, so I will have to either find a different solution or remove the scraper from the final version. I will probably opt to remove it because the feature is more of just a neat trick that only saves a little time for the user.

Authentication

My authentication uses json web token, bcrypt, and React context. The token is stored in local storage - this may need to change as I learn more about JWT. I am not using a refresh token for now, but I may add this in the future.

When the user returns to the website after previously being logged in, a useEffect hook will run because there is local storage data containing the access token. If the token is expired, a 401 status will return and the user will be logged out. If not, the user's data will be available for them. In order to get this to work in the useEffect hook, I had to omit my logout hook as a dependency. React doesn't like this, but I don't think it causes any problems.

If the token expires when the user is trying to post/edit/delete, the user will be logged out and sent back to the homepage. This is done by running a check on the response status - if it is 401, the logout hook is fired. This may be confusing for the user, so if I make this project public, I will want to change it. It would be helpful to at least have a message for the user to read that would pop up on the homepage. Refresh tokens may also solve the problem.

React

One of my main goals with this project was to gain a better understanding of React. I had twenty components, six pages, and a few hooks that helped me get used to the syntax of React.

I used React context for gear and checklist viewing, creating, deleting, and editing. This allowed for easier use in various components. I also used context for authentication.

Organization

As the project progressed, I quickly had a lot of components and a lot of things to implement. In order to prevent myself from becoming overwhelmed, I divided up the components folder into sub-folders based on what page the component is being used for. There is some overlap, but it wasn't a problem.

I had a few functions I was using over and over again - I put these into a utils.js file in a helpers folder to keep it organized. They convert the weight from a number to a string and vice versa as well as handle the gear category titles/icons.

Sorting

The gear data on the closet page and new list page can be sorted by a variety of different categories: name a-z, category a-z, weight, price, and date created. When the users selects a new sorting option, a function is triggered with a switch statement that sorts the data based on the option selected.

The string-based sorts use a .sort method on the array of gear objects with .localeCompare to organize the list alphabetically regardless of upper or lower case characters: setCurrentSortArr([...searchArr].sort((a, b) => a.category.localeCompare(b.category))). To do reverse alphabetical, switch a and b in the sort function.

If a piece of gear does not contain data for the category being sorted, it will automatically be pushed to the end of the list:

setCurrentSortArr([...searchArr].sort((a, b) => {
  if (!a.weight) {
    return 1
  } else if (!b.weight) {
    return -1
  } else {
    return b.weight - a.weight
  }
}))

Design

  • To get a cool looking gradient for the header, I found a picture of a mountain skyline and grabbed the color of the bottom, middle, and top, then recreated the effect using the color values.
  • The PrePacker logo was made with Adobe's logo maker - very cool free software.
  • I decided to use css modules and keep them in a separate styles folder to help keep myself organized. I still kept the index.css file for some global things.

Deployment

I used Netlify for the frontend and Adaptable.io for the backend.

I ran into a few problems when deploying. Heroku would have been my first choice for the backend, but they recently announced that they would no longer be providing a free tier. The next tier up was too expensive for a portfolio project, so I did some research and eventually found Adaptable. They are currently in beta, but the sign up was super simple and they have very good customer support.

Because I'm hosting the backend and frontend at different locations, I needed to install CORS on the backend: app.use(cors({ origin: process.env.CORS_URL })). The environment variable points to the url of the frontend. The best way to trouble shoot this was to go into the development tools of Chrome and look at the error messages in the console and the data in the network tab.

I also needed to use environmental variables in the frontend. Originally I was using a proxy in the package.json file to get around the CORS, but this doesn't work for deployment. So I made an environment variable for the backend url and attached it to the front of all my fetches.

Once the site was running on Netlify, I wasn't able to refresh a page without the app crashing. The routes also wouldn't work when manually typing them in. In order to get around this, you need to have a _redirects file with /* /index.html 200. I put this file into my build folder. If I create another build, I will have to do this again manually. I think this file needs to be created because React is a single page application and Netlify thinks you are going to a different file when you type in a different route.

Coding Note: Make sure you change the environment variable on the frontend to the correct route before trying to run the app locally or before building the app. Add the _redirects file to the build folder before deploying. I may need to change the version of Node I'm using when working on this project (v14).

Miscellaneous Notes

  • In order to use local storage to set state, I had to disable Strict Mode in index.js.
  • Make sure to use array.forEach instead of array.map if you don't have a return value.
  • I'm using axios, bcrypt, cheerio, dotenv, express, jsonwebtoken, mongoose, and validator on the backend and font awesome, date-fns, react, and react-router-dom on the frontend.

Future Updates

I may allow the user to upload photos, share their lists somehow, have container groupings, have a 'wearing' section that doesn't go towards the pack weight, and possibly a few other things. This may require some semi-major reworking. On the backend, the models would be easy to add to, but on the frontend there would need to be some new controls for the user in a few locations and I would have to handle the data from the backend carefully. It may be nice to have custom categories at some point as well.

Right now the checklists don't do much on their own other than congratulate users - it would be nice to keep track of how many times a user used the list.

If I were to open this up to the public, I might include a new page with tutorials on how to use the website. The homepage should also have more indication of what the app does with some videos or GIFs rather than just the text. I would also get a custom domain name. This may happen in the near future.

The first things I will add will probably be password resetting and recovery.

Helpful Resources