Racing to Break the Cycle of Domestic Violence (Back End)

by Maya Dominice

She Codes Plus crowdfunding project - DRF Backend.

Planning

Concept/Name

The concept for this was inspired by my experiences in cycling racing and observing the barriers that women often face in sport and in the community. One of the key races on the cycling calendar is a fundraising event to raise money and awareness about domestic violence, which touches the lives of so many, including women who cycle and race and is one of the biggest women's races on the calender in terms of participation.

Concurrently, women's participation in cycling and racing remains riddled with diffulty/barriers, like so many other male-dominated sports. Everything ranging from outright hostile/unwelcoming behaviour in races/rides to lack of recognition to vastly unequal prize money.

Yet cycling remains a key mechanism to help women move autonomously, freely, cheaply whilst improving fitness and wellbeing - and is an amazing vehicle to bring women together across spaces.

To that end, this fundraising concept is a pivot on an existing model (Sisters of the Saddle: https://sistersofthesaddle.com/) with an application to this key race event.

The crowdfunding site will feature information about the event, and the dedicated domestic violence charities funds are being raised for and the target sum the event wants to raise for the charities.

The premise for donations will be that for each dollar donated, the racing women will train x number of kilometers in preparation/solidarity and fitness acheivement goal.

Women who sign up for the race get a 'rider' account created on the fundraising site, where they can set the target (or max) kms they want to ride, along with the rate per dollar they're willing to challenge themselves with.

When certain collective kms thresholds are acheived in the lead up to the event, the club behind the event can run sessions that the riders/women want eg:

coached bike skills
coached racing skills
ride with an ex-professional woman racer
social/learn to ride with the families/victims of dv (if willing)

Sponsors/donors can donate to riders or to directly to the DV charities nominated.

Intended Audience/User Stories

Target fundraisers are women who are either already cycling and racing and seeking support/community to get more confident on the bike and in racing (whilst also riding for a good cause)

Target sponsorhips/donors would be the broader community, businesses or any entity wanting to make a difference in supporting victims and families of domestic violence and work being done to end the cycle of violence; as well as supporting women's participation in sport and their journey towards healthier lifestyles.

Front End Pages/Functionality

Homepage

Rider Page

User/account Page

API Spec

HTTP Method	Url	Purpose	Request Body	Successful Response Code	Authentication Authorization	Status/Comments
GET	/riders/	Return all riders	N/A	200	N/A	Implemented
GET	/rider/1	Returns the rider with ID of '1' (Rider detail page) and all associated information, updates and donations	N/A	200	N/A	Implemented
GET	/donations/	Returns all donations	N/A	200	N/A	Implemented
DELETE	/donation/1	Deletes a donation	N/A	204	User logged in must be donation owner	Partially completed - permissions not implemented yet
GET	/users/	Return all users	N/A	200	User logged in must be admin user.	Partially completed - permissions not implemented yet
GET	/user/1	Return user with ID of '1'	N/A	200	User of ID '1' must be logged in.	Partially completed - permissions not implemented yet
PUT	/user/1	Update user with ID of '1'	N/A	200	User of ID '1' must be logged in.	Not implemented yet
POST	/users/	Create new user	Example request body: `{"username":"UserName", "email":"emailaddress", "password":"yourpassword" }`	201	N/A	Implemented
POST	/riders/	Create a new project	Example request body: `{"team":"Movistar", "bio":"I'm riding to raise funds", "avatar_image":"https://exampleimage.jpg", "background_image":"https://exampleimage.jpg", "is_active":true, "date_created": "2023-08-12T00:00:00Z", "rate":"1", "kms_ceiling":500}` Valid values for rate are: 1, 2, 5.	201	User must be logged in/authorized (via token); user can only create one rider profile/item.	Implemented
POST	/updates/	Rider can create a progress update item	Example request body: `{"description":"This was a hard week of riding, I did lots of kms.", "image":"https://me_on_my_bike.jpg", "kms_ridden":20}`	201	User must be logged in/authorized (via token) and the owner of the rider profile.	Implemented
PUT	/projects/1	Updates the project with ID of '1'	Example request body: `{"description":"This week I rode a lot of kms, it was hard.", "image":"Project1", "description":"An example project", "goal":5, "image":"https://exampleimage.jpg", "is_open":true, "date_created":"2023-08-12T00:00:00Z", "location_desc":"Brisbane", "location_x":27.4705, "location_y":153.0260}`	201	User must be logged in/authorized (via token). Must be project owner.	Partially implemented, project owner permissions not yet configured
PUT	/pledges/1	Updates the pledge with ID of '1'	Example request body: `{"id":1, "amount":8, "comment":"This is another pledge", "anonymous":false, "project":2}`	201	User must be logged in. Must be pledge creator/supporter.	Partially impemented, permissions as pledge creator not yet configured.

A link to the deployed project.

The project is deployed at this URL: https://desirelines-backend.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.
Step by step instructions for how to register a new user and create a new project (i.e. endpoints and body data).

Register a new user

Using an interface/program of choice (such as Insomnia, Postman or SOAPUI), configure the following request:
- Method: POST
- Endpoint: https://desirelines-backend.fly.dev/users/
No authentication is needed, but if content-type configuration isn't already configured, set this header value to:
- Content-Type | application/json
Configure the body of the request as json, with the following fields:
```
{
    "username": "UserName",
    "email": "[email protected]",
    "password": "YourPassword"
}
```
On successful send, a 200 response is expected with a json response body returned showing the created user:
```
{
    "id": 4,
    "last_login": null,
    "is_superuser": false,
    "username": "User3",
    "first_name": "",
    "last_name": "",
    "email": "[email protected]",
    "is_staff": false,
    "is_active": true,
    "date_joined": "2023-08-13T00:18:13.602362Z",
    "groups": [],
    "user_permissions": []
}
```
How To Create a New Project

Creating a new project requires a user to be authenticated ('logged in'), and this is implemented through token authentication.

Step 1: Generate a token

Using an interface/program of choice (such as Insomnia, Postman or SOAPUI), configure the following request:
- Method: POST
- Endpoint: https://desirelines-backend.fly.dev/api-token-auth/
- Content-Type | application/json
Configure the body of the request as json, with the following fields:
```
{
    "username": "UserName",
    "password": "YourPassword"
}
```
On successful send, a 200 response is expected with a json response body returned with the token value:
```
{
"token": "abcdefghijklmnopqrstuvwxyz123456789"
}
```
Step 2: Create a project using the token to authenticate the request

Configure a new request with the following settings:
- Method: POST
- Endpoint: https://desirelines-backend.fly.dev/projects/
- Content-Type | application/json
Under Authentication types/settings, set Authentication method to 'Bearer Token' (this may vary slightly across interfaces eg in Postman, set it to API Key and include the word 'Token ' prefixed to the token set as API Key).

Copy the token value returned from Step 1 and paste into the token value field.

Configuree the body of the request as json, with the following fields:
```
{
       "title": "My Project",
       "description": "An example project",
       "goal": 5,
       "image": "https://exampleimage.jpg",
       "is_open": true,
       "date_created": "2023-08-12T00:00:00Z",
       "location_desc": "Brisbane",
       "location_x": 27.4705,
       "location_y": 153.0260
}  
```
On successful send, a 201 response is expected with a json response body returned showing the created project details, including the owner and project id:
```
{
	"id": 2,
	"owner": 1,
	"title": "My Project",
	"description": "An example project",
	"goal": 5,
	"image": "https://exampleimage.jpg",
	"is_open": true,
	"date_created": "2023-08-12T00:00:00Z",
	"location_desc": "Brisbane",
	"location_x": 27.4705,
	"location_y": 153.026
}
```
Your refined API specification and Database Schema.

Read on to see project concept details including API specification & schema :)

Project Concept Details

About

Deriving from the urban planning paradigm of the unplanned links forged by people following the path they desire, not the path planned for them, this crowdfunding platform is aimed at providing agency and empowerment to local communities to tackle urban design issues in their neighbourhoods.

Design of and safe mobility through spaces that people inhabit are vital to human health and wellbeing, and often those who live in the area know what's needed best where: one only needs to look for the desire lines already there.

Examples of projects could include community verge gardens, little public libraries, parklets, natural playground equipment, benches/tables or other seating amenities, lighting, artwork pieces, connective pathways, vehicle traffic slowing devices and many more.

Features

Stretch Goals

API Specification

HTTP Method	Url	Purpose	Request Body	Successful Response Code	Authentication Authorization	Status/Comments
GET	/projects/	Return all projects	N/A	200	N/A	Implemented
GET	/projects/1	Returns the project with ID of '1' (Project detail page) and all associated information and pledges	N/A	200	N/A	Implemented
GET	/pledges/	Returns all pledges	N/A	200	N/A	Implemented
GET	/pledges/1	Returns the pledge with ID of '1'	N/A	200	N/A	Implemented
GET	/users/	Return all users	N/A	200	User logged in must be admin user.	Partially completed - permissions not implemented yet
GET	/users/1	Return user with ID of '1'	N/A	200	User of ID '1' must be logged in.	Partially completed - permissions not implemented yet
POST	/users/	Create new user	Example request body: `{"username":"User2", "email":"emailaddress", "password":"yourpassword" }`	201	N/A	Partially completed - returning a 200 response, needs to be updated to 201
POST	/projects/	Create a new project	Example request body: `{"title":"Project1", "description":"An example project","goal":5, "image":"https://exampleimage.jpg", "is_open":true, "date_created": "2023-08-12T00:00:00Z", "location_desc":"Brisbane", "location_x":27.4705, "location_y":153.0260}`	201	User must be logged in/authorized (via token).	Implemented
POST	/pledges/	Create a new pledge	Example request body: `{"amount":8, "comment":"This is another pledge", "anonymous":false, "project":2}`	201	User must be logged in/authorized (via token).	Implemented
PUT	/projects/1	Updates the project with ID of '1'	Example request body: `{"id":1, "title":"Project1", "description":"An example project", "goal":5, "image":"https://exampleimage.jpg", "is_open":true, "date_created":"2023-08-12T00:00:00Z", "location_desc":"Brisbane", "location_x":27.4705, "location_y":153.0260}`	201	User must be logged in/authorized (via token). Must be project owner.	Partially implemented, project owner permissions not yet configured
PUT	/pledges/1	Updates the pledge with ID of '1'	Example request body: `{"id":1, "amount":8, "comment":"This is another pledge", "anonymous":false, "project":2}`	201	User must be logged in. Must be pledge creator/supporter.	Partially impemented, permissions as pledge creator not yet configured.

Third Party API - Geocoding

I experimented with the Geoscape G-NAF Predictive API to see if I could incorporate the predictive address as part of the process to obtain X,Y coordinates of the project location (https://docs.geoscape.com.au/docs/oas-predictive-api/). Managed to get repsonses/interaction with the API through the views.py of Project, but wasn't quite sure how much further to push along this path or wait until we learn React and make it a front-end thing :) The bits of work I did on this are in the geoscape_api branch.

Database Schema

The fields and tables relating to the goals arent't yet deployed - planning to try and include this so that users can create a project with three subtype goals - financial, time/skills and items - as often a community project takes on all these elements - eg for a community garden, some people can offer goods like soils, straw or seedlings, others can offer skills/time such as building a garden bed and others can offer money to purchase items such as soil, irrigation piping etc.