Skip to content

Beerooke31/crowdfunding_back_end

Repository files navigation

Crowdfunding Back End

Brooke Pierson

Planning:

Concept/Name

Starbounty - A crowdfunding platform to fund occult research. This could include endeavours such as exploration of a haunted house or a UFO crash landing site, with researchers ranging from scientists to your average Joe. Project creators can gain funding for tools, travel expenses, amenities - basically anything they require to conduct their research and unravel the mysteries of the universe.

Intended Audience/User Stories

The intended audience/user includes researchers interested in occult studies who want to create a crowdfunding campaign to allow access to the necessary resources to investigate their chosen topic. A secondary user is someone who has a desire to know more about paranormal topics but doesn't necessarily want to go out into the field themself, however, is happy to donate to an individual/group who can investigate on their behalf and provide feedback on their findings.

Front End Pages/Functionality

  • {{ A page on the front end }}
    • {{ A list of dot-points showing functionality is available on this page }}
    • {{ etc }}
    • {{ etc }}
  • {{ A second page available on the front end }}
    • {{ Another list of dot-points showing functionality }}
    • {{ etc }}

API Spec

URL HTTP Method Purpose Request Body Success Response Code Authentication/Authorisation
/api-token-auth/ POST Returns authentication token for user {
"token": "",
"user_id": "",
"email": ""
}
200 N/A
/projects/ GET Returns all projects N/A 200 N/A
/projects/1/ GET Returns a project with ID "1" N/A 200 N/A
/projects/ POST Creates a new project {
"title": "",
"description": "",
"goal": "",
"image": "",
"is_open": "",
"date_created": ""
}
201 Must be logged in
/projects/1/ PUT Updates project with ID "1" {
"title": "",
"description": "",
"goal": "",
"image": "",
"is_open": "",
"date_created": ""
}
200 Must be logged in.
Must be project owner or admin.
/projects/1/ DELETE Deletes project with ID "1" N/A 204 Must be logged in.
Must be project owner or admin.
/pledges/ GET Returns all pledges N/A 200 N/A
/pledges/1/ GET Returns a pledge with ID "1" N/A 200 N/A
/pledges/ POST Creates a new pledge {
"id": "",
"supporter": "",
"amount": "",
"comment": "",
"anonymous": "",
"project": ""
}
201 Must be logged in.
/pledges/1/ PUT Updates pledge with ID "1" {
"id": "",
"supporter": "",
"amount": "",
"comment": "",
"anonymous": "",
"project": ""
}
200 Must be logged in.
Must be pledge owner or admin.
/pledges/1/ DELETE Deletes pledge with ID "1" N/A 204 Must be logged in.
Must be pledge owner or admin.
/users/ GET Returns a list of all users N/A 200 N/A
/users/1/ GET Returns user with ID "1" N/A 200 N/A
/users/ POST Creates a new user {
"id": "",
"last_login": "",
"is_superuser": "",
"username": "",
"first_name": "",
"last_name": "",
"email": "",
"password": "",
"is_active": "",
"date_joined": "",
"groups": "",
"user_permissions": ""
}
201 Must be logged in.

DB Schema

ERD_Diagram

Link to deployed project

https://starbounty-d5b76e766824.herokuapp.com/

Insomnia Screenshots

Insomnia Screenshots

User and Project Registration Steps

User Steps

Project Steps

About

A repo to contain my SheCodes crowdfunding project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published