Skip to content

pangtodd/yrzTruly

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

YoursTruly (yrztruly.com)

By Todd Pangilinan

A react app to help you say that special thing to that not-so-special someone.

Technologies Used

  • React
  • JavaScript
  • Firebase
  • Material UI
  • NPM
  • HTML
  • CSS

Description:

At the workplace, has someone passed you an evelope with a birthday card and you draw a blank on what to say? Maybe you notice how creative Bob's note was, and you feel pressure to write something witty. Instead of agonizing over what to say or worse, just signing your name with a lame, "happy birthday", you can visit Yours Truly (yrztrly.com) for some inspiration.

Yours Truly is a web app that maintains a database of messages for common greeting cards. It allow users to browse differ catagories and get messages they can borrow or modify to help get that card signed fast. It is a React-based app that provides authentication and users CRUD functionality (they can only delete or edit their own entries). Users must log in to get write/edit/delete access.

The following user stories were considered in planning this app:

  • As a user, I want to see suggestions on what I could write in someone's card.
  • As a user, I want to be able to add suggesitions to the database.
  • As a user, I want to be able to upvote suggestions I like and downvote suggesions I don't (still working on this feature).
  • As a user, I want to be able to log in and flag suggestions as inappropriate (still working on this feature).
  • As a user, I want to be able to log in and provide a suggestion.
  • As a user, I want to be able to see different suggestions based on the occasion and the relationship I have to the person.
  • As an admin, I want to full CRUD access to messages (still working on this feature).

Diagram of components

Diagram

Setup/Installation Requirements

  • If you don't have Git installed on your machine, follow these instructions.
  • Via your terminmal, navigate to the directory you want to store my files in.
  • Clone my git hub directory by typing or cutting pasting: "git clone https://github.com/pangtodd/yrzTruly.git" into your terminal.
  • open files in a code editor of your choice.
  • NOTE: this project was created in a Mac environment. There may be minor changes if you use a PC.
  • open terminal or bash, and navigate to the root level of the project, enter "npm install".
  • After the dependencies have been loaded, in the terminal, run "npm run start". This should bring up a browswer to localhost3000 and start the app.
  • hopefully I'll get this project deployed, but we'll see!

Known Bugs

  • As of 10/9/2022, no known bugs
  • email [email protected] if you notice any problems or have feedback

License

MIT Copyright (c) Todd Pangilinan

Contact Information

[email protected]

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published