/ubiquitous-giggle

An application that reminds the user of certain dates to send to friends and family gifts and/or cards.

Primary LanguageJavaScript

Keep on Giftin'

Table of Contents:

  1. Description
  2. Installation
  3. Usage
  4. Licence
  5. Credits
  6. Suggestions
  7. Questions

Description:

An application that reminds the user of certain dates to send friends and family gifts/cards.

The user will create profiles for each family member or friend. Profile includes:

  • Date of Birth
  • Relationship to user
  • Annual holidays the person celebrates
  • Custom holidays for one-time events (graduations, weddings, etc.) that they are celebrating
  • Home address to send gifts/cards to

Then the app will produce a calendar with reminders of specific dates a few days before to remind to send a gift. Once the annual event has passed, date will reset to next year. One-time events will disappear.

Installation:

To install and run locally from Git Hub repository, go to the repository: https://github.com/girl-power-5 Click CODE box, select SSH and copy the repository to your clipboard. In your command-line navigate to the folder you want to hold the repository. Once there type 'git clone' and paste the repository information into the line. Once completed open the code in VS by typing the command code . This will take you to VS Code and you will be in the repository on your local machine.

Once cloned,create package.json using npm init. The "dependencies" used:

  • Bcryptjs v2.4.3
  • dotenv v8.2.0
  • Express v4.17.1
  • Express-handlebars v5.2.0
  • Express-session v1.17.1
  • Flatpickr v4.6.9
  • Mysql2 v2.2.5
  • Passport v0.4.1
  • Passport-local v1.0.0
  • Pikaday v1.8.2
  • Sequelize v6.4.0

To access from a browser: https://keep-on-giftin.herokuapp.com/

Usage:

When the user navigates to the page they will be presented a "Login Form".
They will enter their email address and password to sign into the application, or they will click the link at the bottom of the page to sign up and create a new email and password for login.
Once the user is signed in, they will be taken to the dashboard where they can see current profiles. They will be able to open the profile page or edit the profile information. They can also create a new profile by clicking the link at the bottom of the page.
The sidebar on the dashboard page will provide links to navigate the page.

login signup dashboard create_profile view_profile

License:

MIT Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Credits:

Members and Tasks: Claudia Alpert - Front-End
Emily Blair - Back-End
Amber Chiodini - DataBase
Jen Doyle - Research
Melissa Ward - GitHub

Other Credits:
General Info: http://www.google.com
Passport: https://www.youtube.com/watch?v=hNinO6-bDVM
Flatpickr: https://codepen.io/riyos94/pen/xppbBj
HW 14 Passport

Many thanks to the support of our project advisor, team leads, tutors, and classmates who took the time to help us troubleshoot to get everything working properly. Without your support, we would not have this application running.

Suggestions

We are always looking to improve our application, please feel free to reach out with suggestions or holiday ideas.
amber.park@northwestern.edu claudiaalpert@gmail.com emilyblair96@gmail.com jen.doyle5254@gmail.com melissaward953@gmail.com

Questions:

For more information on this project, here is a link to our organization on GitHub.

Girl-Power 5 Members:
Claudia Alpert
Emily Blair
Melissa Ward
Amber Chiodini
Jen Doyle