{{ THE SCRUB HUB }}

{{ TARGET AUDIENCE - ALL / CHARITY ORGANISATIONS / VOLUNTEERS Purpose To provide a Mobile Shower Service for the homeless people in Perth. This will be done by fitting old buses with hot shower facilities. Requirements Amount to raise per bus - $20,000 Funding for bus to be fitted with showers & basins to be tapped into hot water.

Future State Funding for storage racks to be fitted Volunteer to pledge time or donations of clothing, toiletries. Doctor Services

}}

Features

SIMPLE SITE WITH LANDING PAGE, ABOUT US, PURPOSE, GOAL & MISSIONS PROJECT SITE WITH 2 PROJECTS USERS CAN CREATE ACCOUNTS TO PLEDGE, ADD COMMENTS.

User Accounts

• Username
• Email Address
• Password

Project

• Create a project
  • Title
  • Owner (a user)
  • Description
  • Image
  • Target Amount to Fundraise
  • Open/Close (Accepting new supporters)
  • When was the project created
  • Ability to pledge to a project
  • An amount
  • The project the pledge is for
  • The supporter
  • Whether the pledge is anonymous
  • A comment to go with the pledge

Implement suitable update delete

Note: Not all of these may be required for your project, if you have not included one of these please justify why.

• Project
  • Create - ADDED
  • Retrieve - ADDED
  • Update - TO BE IMPLEMENTED | CURRENTLY CODE IS UNDER CONSTRUCTION
  • Destroy - TO BE IMPLEMENTED | CURRENTLY CODE IS UNDER CONSTRUCTION
• Pledge
  • Create - ADDED
  • Retrieve - ADDED
  • Update - TO BE IMPLEMENTED | CURRENTLY CODE IS UNDER CONSTRUCTION
  • Destroy - TO BE IMPLEMENTED | CURRENTLY CODE IS UNDER CONSTRUCTION
• User
  • Create - ADDED
  • Retrieve - ADDED
  • Update - TO BE IMPLEMENTED | CURRENTLY CODE IS UNDER CONSTRUCTION
  • Destroy - TO BE IMPLEMENTED | CURRENTLY CODE IS UNDER CONSTRUCTION

Implement suitable permissions

Note: Not all of these may be required for your project, if you have not included one of these please justify why.

• Project
  • Limit who can create | ADDED ONLY SUPERUSER / ADMIN ONLY FOR PROJECTS / PERMISSIONS TO BE REFINED
  • Limit who can retrieve | ALL CAN VIEW PROJECTS
  • Limit who can update | ADDED ONLY SUPERUSER / ADMIN ONLY FOR PROJECTS / PERMISSIONS TO BE REFINED
  • Limit who can delete | ADDED ONLY SUPERUSER / ADMIN ONLY FOR PROJECTS / PERMISSIONS TO BE REFINED
• Pledge
  • Limit who can create | ADDED
  • Limit who can retrieve | NOT ADDED AS ALL CAN VIEW
  • Limit who can update | ADDED
  • Limit who can delete | ADDED
• Users
  • Limit who can retrieve | TO BE IMPLEMENTED | CURRENTLY CODE IS UNDER CONSTRUCTION
  • Limit who can update | ADDED
  • Limit who can delete | NOT ADDED AT THIS STAGE. UNSURE AS TO WHETHER USERS CAN DELETE THEIR OWN ACCOUNTS.

Implement relevant status codes

• Get returns 200
• Create returns 201
• Not found returns 404

Handle failed requests gracefully

• 404 response returns JSON rather than text

Use token authentication

• impliment /api-token-auth/

Additional features

• {TOTAL PLEDGES 1}

{{ SUM OF ALL PLEDGES FOR EACH OF THE PROJECTS}}

• {COMMENTS ON PROJECTS}

{{ ALLOWS THOSE LOGGED IN TO BE ABLE TO ADD COMMENTS TO THE PROJECTS}}

• {FILTERS TO PLEDGES, COMMENTS & USERS}

{{ FILTERS TO PLEDGES, COMMENTS & USER }}

External libraries used

• django-filter - FILTERS - 'DEFAULT_FILTER_BACKENDS' 'django_filters.rest_framework.DjangoFilterBackend',

Part A Submission

• A link to the deployed project - https://spring-glade-2620.fly.dev/projects/
• A screenshot of Insomnia, demonstrating a successful GET method for any endpoint.
• A screenshot of Insomnia, demonstrating a successful POST method for any endpoint.
• A screenshot of Insomnia, demonstrating a token being returned.
• Your refined API specification and Database Schema.

Step by step instructions for how to register a new user and create a new project (i.e. endpoints and body data).

1. Create User

curl --request POST \
  --url https://spring-glade-2620.fly.dev/users/ \
  --header 'Content-Type: application/json' \
  --data '{
	"username": "testuser",
	"email": "not@myemail.com",
	"password": "not-my-password"
}'

2. Sign in User

curl --request POST \
  --url http://127.0.0.1:8000/api-token-auth/ \
  --header 'Content-Type: application/json' \
  --data '{
	"username": "testuser",
	"password": "not-my-password"
}'

3. Create Project

curl --request POST \
  --url https://spring-glade-2620.fly.dev/projects/ \
  --header 'Authorization: Token 5b8c82ec35c8e8cb1fac24f8eb6d480a367f322a' \
  --header 'Content-Type: application/json' \
  --data '{
	"title": "Donate a cat",
	"description": "Please help, we need a cat for she codes plus, our class lacks meows.",
	"goal": 1,
	"image": "https://upload.wikimedia.org/wikipedia/commons/c/c1/Dollar_bill_and_small_change.jpg",
	"is_open": true,
	"date_created": "2023-01-28T05:53:46.113Z"
}'