Skip to content

KalinRamsey/23.5_Favr-API

Repository files navigation

FAVR App

Live Demo Client Repo

Tech Used:

  • PostgreSQL
  • Express
  • ReactJS
  • NodeJS
  • CSS

Summary:

  • The landing page displays an informational overview about how to use the application. Landing Page Screenshot

  • User is able to create a new ccount by submitting a unique username, along with an email address and validated password. Sign Up Screenshot Log In Screenshot

  • Once logged in, user is directed to Favors page to view list of their current to-do list, as well as an aggregate list of favors they have tasked to other users

  • User can create new favors, to send to others, delete favors they've assigned to others, and mark favors on their personal to-do list as 'completed' or 'cancelled' Favors Screenshot Create Favor Screenshot

  • User can review statistics on their personal account, as well as customize a header image and about_me section Profile Page Screenshot Edit Profile Screenshot

  • Visitors can view information about the app's creator by clicking the button in the bottom-right corner of all pages at any time About The Author Screenshot

API Documentation:

Users

  • (/)
    • GET: Returns a list of all current users registered
    • POST: Create new user with params { email, username, password }
  • (/:userId)
    • GET: Return a single user
    • PATCH: Edit { about_me, profile_img, date_modified } of a single user, given a specific ID and valid authentication
    • DELETE: Remove a user from the database given a specific user ID and valid authentication
  • (/:userId/favors)
    • GET: Return all Favors assigned to a user, given a specific user ID
    • POST: Add a new Favor to a user's collection with params { favor_title, favor_content, to_user_id, from_user_id }

Favors

  • (/)
    • GET: Returns all Favors stored in the database
    • POST: Add a Favor to the database with params { favor_title, favor_content, to_user_id, from_user_id }
  • (/:favorId)
    • GET: Return a specific Favor, given a specific Favor ID
    • PATCH: Edit a specific Favor with params { completed, cancelled, end_date }, given a specific Favor ID and valid authentication
    • DELETE: Remove a specific Favor from the database, given a specific Favor ID and valid authentication

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published