PresentPal

Plan. Shop. Joy. 🎄✨

Tech Turtles

• PresentPal
  • Project Overview 🎁
  • Mission Statement 🔊
  • Features 📋
    • All Features
    • Must haves
    • Nice to haves - First Priority
    • Nice to haves - Other
    • Summary
    • Users
    • Christmas List
    • Pages/Endpoint Functionality
  • Technical Implementation 🧑‍💻
    • Back-End 👈
    • Front-End 👉
    • Source Code Management 👷
    • Deployment ▶️
  • Target Audience 👥
  • User Stories 📖
    • Gift Giver User Stories 👼🏻
      • List Management
      • Sharing and Collaboration (stretch goal)
      • Mobile Experience
    • Gift Recipient User Stories 🥳
  • Back-end Implementation
    • API Specification 📍
    • Object Definitions
      • User
      • Lists
      • Items
      • Recipients
    • Database Schema

Project Overview 🎁

PresentPal is a web application designed to streamline gift planning and purchasing, starting with a focus on Christmas shopping and with the potential to expand into birthday and other event planning. The platform aims to eliminate the stress of last-minute shopping and provide a more organised and thoughtful approach to gift-giving.

Mission Statement 🔊

PresentPal’s mission is to simplify holiday/event gift shopping by providing a seamless platform where users can create, organise and share personalised gift lists. Whether for personal use or to help find the perfect gift for loved ones, PresentPal enables easy tracking of items and their sources, making gift-giving more thoughtful, efficient and enjoyable.

Features 📋

All Features

• Creation of user account
• Log in/Log out
• Ability to create/edit/delete list
• Add recipients to each list
• Add item details and assign to a recipient on the list
• Ability to update the status of individual items
• Accessibility for colour blind users
• Management of budget (total spent)
• Custom 404 page
• Responsive design

Must haves

• Homepage

  • Anyone can view the website
  • Users can create an account. Create account page will have email, first name, last name and password fields
  • Users can create a list if they are logged in

• User Profile Management and Permissions

  • Users can log in or log out of their account
  • Login page will have username and password fields
  • Each user category will have their set permissions they can view

• List Page

  • Admin/superusers can create or delete any of the lists
  • Users can create a list, but can only edit/delete a list they have created
  • Has space to record and update gift details (product name, price, store/link)
  • Status of item (complete/incomplete)

Nice to haves - First Priority

1. Priority of item, e.g. when child adds multiple items
2. Status of item (not ordered, ordered but hasn't arrived)
3. Due date when gift is required by
4. Item count - total items

Nice to haves - Other

• Secure sharing of list, e.g. User wants to send list to children to add ideas
• Grouping of items
• Ability to print list
• QR code generation
• Budget by category
• Birthday list integration
• Gift suggestions
• Sale notifications
• About page
• Forgot password on login page

Summary

Provide users the ability to create lists of gifts they need to purchase. Once items are listed, users can edit/delete individual items and update each item's status. Only Superuser can view all lists and individual users can view the lists created by them.

Users

Type	Access	Role type assignment
Superuser or admin	- All access - Can log in and log out - Create and manage lists - Create and manage other users - Update status of items on list - Delete a list	Private: Shelley Behen
User	- Can log in and can log out - Create and edit items on their list - Delete item from their list	Public: Users who want to create a gift shopping list

Christmas List

Feature	Access	Notes/Conditions
Create	Can be created by anyone with a registered account	User must be logged in
View	Admin/superuser and creator of the list can view list	User must be logged in
Edit	Admin/superuser and creator of the list can edit list	User must be logged in
Delete	Can be deleted by admin/superuser and creator of list	User must be logged in

Pages/Endpoint Functionality

Endpoint	Functionality	Comments
List page	- Available to user who created list - Available to admin/superusers - Users can edit lists	- Easy to read and accessible - Good contrast
User page	- Users can view all lists created - Users can create new list
Home page	- Button to create list or log in button if not logged in - Description about app

Technical Implementation 🧑‍💻

Back-End 👈

• Django/DRF API
• Python

Front-End 👉

• React/JavaScript
• HTML/CSS

Source Code Management 👷

• Git

Deployment ▶️

The application's front-end will be deployed to Netlify. The back-end and DB will be deployed to Heroku.

We will also use Insomnia to ensure API endpoints are working smoothly (we will utilise a local and deployed environment in Insomnia).

Link to Heroku deployed backend

Link to Netlify deployed frontend

Target Audience 👥

• Gift Giver (Primary User)
• Gift Recipient (Secondary User)

PresentPal caters to two key groups in the gift-giving process. The primary users are busy gift-givers, often balancing work and family, who want to organise their holiday shopping efficiently. They use the platform to create gift lists, track recipients, and monitor their shopping progress, reducing stress and last-minute hassles.

The secondary users are gift recipients, who can join in by creating their own wishlists when invited by a gift-giver. This collaborative approach ensures gifts are thoughtful and easier to choose, while still keeping the surprise alive during the holiday season.

User Stories 📖

Gift Giver User Stories 👼🏻

List Management

1. As a gift giver, I want to create a new gift list so that I can organise my Christmas shopping.
2. As a gift giver, I want to add recipients to my list so that I can plan gifts for everyone.
3. As a gift giver, I want to add gift details (name, price, store link, notes) so that I can track what to buy.
4. As a gift giver, I want to mark items as purchased so that I can track my shopping progress.
5. As a gift giver, I want to see the total cost of all gifts so that I can manage my budget.
6. As a gift giver, I want to keep the list private from each recipient so that gifts remain a surprise.

Sharing and Collaboration (stretch goal)

1. As a gift giver, I want to invite recipients to edit their gift lists so that I know what they want.
2. As a gift giver, I want to share my list with family members so that we can coordinate gift buying.
3. As a gift giver, I want to keep gift details private from recipients so that surprises aren't spoiled.

Mobile Experience

1. As a gift giver, I want to access my lists on a mobile device so that I don’t always have to turn on my laptop.
2. As a gift giver, I want the website to load quickly so that I can check lists efficiently.

Gift Recipient User Stories 🥳

1. As a gift recipient, I want to add items to my gift list so that I receive gifts I'll enjoy.
2. As a gift recipient, I want to edit my gift list so that I can keep it up to date.

Back-end Implementation

API Specification 📍

HTTP Method	URL	Purpose	Request Body	Success Code	Auth & Permissions
POST	/api-token-auth/	Allow users to log in and get token auth	"username": "string", "password": "string"	200	NA
GET	/users/	View all user profiles	NA	200	Superuser or admin, must be logged in
POST	/users/	Create new user	"username": "string", "first_name": "string", "last_name": "string", "email": "string", "password": "string"	201	NA
GET	/users/{id}/	View user profile	NA	200	Superuser, admin or creator of user profile, must be logged in
PUT	/users/{id}/	Edit user profile	"username": "string", "first_name": "string", "last_name": "string", "email": "string", "password": "string"	200	Superuser, admin or creator of user profile, must be logged in
DELETE	/users/{id}/	Delete user	NA	204	Superuser, admin or creator of user profile, must be logged in
GET	/lists/	View all lists	NA	200	Superuser, admin or creator of list, must be logged in
POST	/lists/	Create list	"name": "string", "description": "string", "budget": "integer", "is_open": "boolean"	201	Must be logged in
GET	/lists/{id}/	View list	NA	200	Superuser, admin or creator of list, must be logged in
PUT	/lists/{id}/	Update list	"name": "string", "description": "string", "budget": "integer", "is_open": "boolean"	200	Superuser, admin or creator of list, must be logged in
DELETE	/lists/{id}/	Delete list	NA	204	Superuser, admin or creator of list, must be logged in
GET	/recipients/	View all recipients	NA	200	Superuser, admin or creator of list, must be logged in
POST	/recipients/	Create recipient	"name": "string", "is_open": "boolean"	201	Superuser, admin or creator of list recipient is associated with, must be logged in
GET	/recipients/{id}/	View recipient	NA	200	Superuser, admin or creator of list recipient is associated with, must be logged in
PUT	/recipients/{id}/	Update recipient	"name": "string", "is_open": "boolean"	200	Superuser, admin or creator of list recipient is associated with, must be logged in
DELETE	/recipients/{id}/	Delete recipient	NA	204	Superuser, admin or creator of list recipient is associated with, must be logged in
GET	/items/	View all items	NA	200	Superuser, admin or creator of list, must be logged in
POST	/items/	Create item	"name": "string", "cost": "float", "where_to_buy": "string", "notes": "string", "priority": "integer", "delivery_status": "string", "status": "string", "due_date": "datetime", "is_open": "boolean"	201	Superuser, admin or creator of list item is associated with, must be logged in
GET	/items/{id}/	View item	NA	200	Superuser, admin or creator of list item is associated with, must be logged in
PUT	/items/{id}/	Update item	"name": "string", "cost": "float", "where_to_buy": "string", "notes": "string", "priority": "integer", "delivery_status": "string", "status": "string", "due_date": "datetime", "is_open": "boolean"	200	Superuser, admin or creator of list item is associated with, must be logged in
DELETE	/items/{id}/	Delete item	NA	204	Superuser, admin or creator of list item is associated with, must be logged in
GET	/recipients/{uuid}/	View recipient items	NA	200	NA
POST	/recipients/{uuid}/	Create recipient item	NA	204	NA

Object Definitions

User

Field	Data type
User_ID (PK)	integer
First Name	string
Last Name	string
Username (unique)	string
Is_superuser	boolean
Is_staff	boolean
Is_active	boolean
Email (unique)	string
Password	string
Date created	datetime

Lists

Field	Data Type
List_ID (PK)	integer
Name	string
Description	string
Budget	integer
Total_cost	integer
Is_open	boolean
Date_created	integer
Owner_Id	integer

Items

Field	Data Type
Item_ID (PK)	integer
Name	string
Cost	integer
Where_to_buy	string
Notes	string
Priority_order (1, 2, 3)	integer
Delivery_status (ordered, shipped, delivered, na)	string
Status (complete/incomplete)	boolean
Due_date	datetime
Is_open	boolean
Date_created	integer
Recipient_ID	integer

Recipients

Field	Data Type
Recipient_ID (PK)	integer
Name	string
Is_open	string
Date_created	string
List/_ID	integer
UUID code	string
Total_items	integer

Database Schema