Git Product home page Git Product logo

eggstagram's Introduction

e ๐Ÿฅš ๐Ÿฅš stagram

Authors:

Run Eggstagram!

Initial Set Up

  1. Run git clone https://github.com/celebilaw/eggstagram.git in the desired folder
  2. Navigate into the folder eggstagram/eggstagram via the following command
  • cd eggstagram/eggstagram
  1. Run npm install
  2. Run npm install -g nodemon

Starting Backend

  1. Navigate into the folder eggstagram/eggstagram/backend via the following command
  • cd backend
  1. Run nodemon server

Starting Frontend

  1. Create a new terminal window
  2. Navigate into the folder eggstagram/eggstagram
  • cd eggstagram/eggstagram
  1. Run npm start

Using the Website

  1. Eggstagram will open in a new browser at http://localhost:3000
  2. Start interacting with our website!

Users must be logged in to:

  • Post
  • Like
  • Comment
  • Edit Your Posts
  • Delete Your Posts

Your login will time out in 1 hour


Navigation and Feed

General Navigation
  • Click "Eggstagram" (or the logo) in the top left of the website to return to the Home Page
  • Click "Posts" in the top right to see the Post Feed
  • Click "Make a Post!" in the top right to make your own post
  • Click "Create an Account" in the top right to make your own account
  • Click "Login" in the top right to sign in to your account
  • Click "Logout" in the top right to sign out of your account
Feed Navigation
  • Clicking on a post in the feed will allow you to view the post itself (likes and comments)
    • From here, if logged in, you can submit your own comments and like a post
    • If you made the post, you can edit the description or delete it (you may have to scroll down to see the area to Edit)
  • Click "Posts" (in the top right) to return to the feed
Feed Filtering
  • Posts can be filtered by description, dining hall, or rating
  • Typing in a description will open a dropdown of individual posts for you to select and consequently view
  • Clicking the "X" in the search bar for descriptions will remove what you have typed if you decide to not search for a post
  • Selecting a Dining Hall from the dropdown will change the feed to only show reviews pertaining to that Dining Hall
  • Selecting "Show All" in the dropdown will remove the Dining Hall Filter you previously selected
  • Selecting a Star Rating will change the feed to only show reviews of that Star Rating
  • Selecting the same Star Rating you previously selected will undo the Star Rating Filter (ex: clicking the 4th star after filtering to 4 Star Ratings)

Closing the Website

  1. In the nodemon server terminal window, input the command Ctrl - C to shut down the backend
  2. In the npm start terminal window, input the command Ctrl - C and Y to shut down the frontend

eggstagram's People

Contributors

celebilaw avatar noahg303 avatar wathmew avatar joelh11 avatar mgduran avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.