search

srsexton94 / mutualaid-api

A social networking app designed to support Mutual Aid network organizing efforts
https://fast-oasis-63373.herokuapp.com/
0 stars 0 forks source link

readme

Mutual Aid, Dual Power: Server Side

Project Description

This project is a social networking app that is designed to support Mutual Aid network organizing efforts. Recently, in the wake of the COVID-19 global crisis, Mutual Aid networks and resources have emerged all over the world. However many of the networks are disconnected and there isn’t a prominent common resource connecting/compiling this information.

This app is intended to stand as a both a network in and of itself, as well as a compilation of other networks and resources to help get users connected to the resources they need, in the medium that works for them.

This repo is the custom API for this project. It presents a 'user' resource (with a unique email and hashed password) along side a 'post' resource to which registered users are able perform all CRUD actions. Additionally all visitors to the site, regardless if they sign up for an account or not, are able to view the various posts.

The front end repo includes further detailed information on the tradition and history of the title concepts, especially in how they inform this project.

Project Links

Technologies

On the server side, the technologies used include...

Dependencies (Set up & Installation)

Planning Process

The planning process for this project's API began by outlining the User Stories (common between front and back end) and the ERD. The ERD outlines a stretch goal resource ('comments') that at this time has not yet been implemented, but could be useful for future developement. Additionally, though working independently, a project board was made as a task list to track progress.

User Stories

ERD

Route Catalog

User Routes
/sign-up POST CREATE
/sign-in POST CREATE
/change-password PATCH UPDATE
/sign-out DELETE DESTROY
Post Routes
/posts GET INDEX
/posts/:id GET SHOW
/posts/:id/edit PATCH UPDATE
/create-post POST CREATE
/posts/:id DELETE DESTROY

Problem Solving

The planning of this project placed great emphasis on identifying a suitable MVP scenario, so that the details of the app's basic functionality could be realized more effectively and problems could be more easily parsed. Additionally, utilizing the project board acted as a visualized trajectory of the project. This helped greatly in parsing both the intent and execution of each component part of this project. It also serves the added benefit of increasing accesibility and easing the onboarding process for any new collaborators as this project moves forward. For the server side application in particular, utilizing postman script testing proved endlessly useful in debugging formatting and authentication errors.

Unsolved Problems

At current publication the MVP scenario outlined below is considered successful; as is the first of the Moderate Stretch Goals (displaying posts sorted by type).

The other stretch goals have not yet been attempted and contribution is welcomed. It is vaguely intended to proceed more or less in the order presented below, but the order is flexible should reason present itself.

Additionally, a data collection and cleaning process is underway. Once the data is adequately formatted, it should be uploaded to the database.

MVP

Moderate Stretch Goals

Stretch "for the stars!" Goals