Project Title

The Rundown

Project Description

An app where users can create business listings and leave reviews about their experiences with them giving all other users "the rundown" on what those businesses are all about.

GitHub Repo Links

Project Schedule

Day Component
1 Backend Models & Serializers
2 Backend Urls
3 Connect to Frontend and Implemnent GET functionality
4 Implement Frontend Create Functionality
5 Implement Frontend Delete & Update Functionality
6 CSS
7 CSS
8 Debugging

Wireframes

Home Page
Search Page
Create Page
Update/Delete Page
Register User Page

React Component Architecture

React Architecture

Database Models

class Business(models.Model):
    name = models.CharField(max_length=255)
    image_url = models.URLField(max_length=255, blank=True)
    category = models.CharField(max_length=255)
    location_city = models.CharField(max_length=255)
    location_state = models.CharField(max_length=2)
    price = models.CharField(max_length=5)
    phone = models.CharField(max_length=10)
    created_at = models.DateTimeField(auto_now_add=True)
    updated_at = models.DateTimeField(auto_now=True)
    owner = models.ForeignKey(User, on_delete=models.CASCADE)
    is_public = models.BooleanField(default=True)

    class Meta:
        verbose_name = "Business"
        verbose_name_plural = "Businesses"

    def __str__(self):
        return self.name


class Review(models.Model):
    business = models.ForeignKey(Business, related_name='business_review', on_delete=models.CASCADE)
    rating = models.FloatField()
    review = models.TextField(blank=True)
    created_at = models.DateTimeField(auto_now_add=True)
    updated_at = models.DateTimeField(auto_now=True)
    owner = models.ForeignKey(User, on_delete=models.CASCADE)
    is_public = models.BooleanField(default=True)

    def __str__(self):
        return self.business.name + " - " + self.review

MVP / PostMPVP

I was able to fully complete my MVP but was not able to get to any PostMVP.

MVP

  • Be able to add business info to database, update business info, create business listing, delete business listings.
  • Be able to create, update, and delete business reviews.

PostMVP

  • Add businesses to favorites list.
  • Add other users as friends.

Time / Priority Breakdown

Component Priority Estimated Time Time Invetsted Actual Time
Adding Login Form H 4 hrs 1 hr 1 hr
Creating Backend H 4 hrs 12 hrs 12 hrs
Creating Register User Page H 4 hrs 1 hr 1 hr
Implementing search H 4 hrs 0 hrs 0 hrs
Creating Update/Delete Review Page H 4 hrs 9 hrs 9 hrs
Creating add Business Page H 4 hrs 6 hrs 6 hrs
Testing M 5 hrs 5 hrs 5 hrs
Adding Styling M 5 hrs 2 hrs 2 hrs
Deployment H 3hrs 10 hrs 10 hrs
Implement Favorites list L 4 hrs 0 hrs 0 hrs
Total 43 hrs 40 hrs 40 hrs

Additional Libraries

axios
bootstrap
react-bootstrap
react-router-dom

Screenshots

Home Page Sign Up Log In Dashboard Business Page Review Page Add Business

Code Snippet

I'm sharing the particular code snippent below because I thought it was a pretty clever way of getting the business id to the handle function so it can be stored in state. I set the value prop of the submit button to {business[0].id} so that when it was clicked it would get sent to the handleChange function and get stored into state.

<textarea className="form-control" id="exampleFormControlTextarea1" rows="3" name="review" value={rundownContext.reviewInfo.review} onChange={rundownContext.handleReviewChange}></textarea>
                    </div>
                    <button type="submit" className="btn btn-info" name="business" value={business[0].id} onClick={rundownContext.handleReviewChange}>Post Review</button>

Issues and Resolutions

Spent too much time trying to replicate yelp's API exactly in Python and trying to match all the nesting and depths of data. Things got so convoluted I had to undo it all and settle for two simple models that were easy to work with.

Could not figure out how to deploy backend with DEBUG=FALSE.

Spent too much trying to figure out why I couldn't delete things when it ended up I was just missing a '/' at the end of my URL.

Was researching how to get the value of radio buttons and couldn't find any satisfying answers but I was able to figure it out through trial and error on based on what I knew about getting the value of other types of inputs.

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify