danieleframpton / paired-be

Back-end suite of micro-services for Paired app (http://paired.tech)

Paired Back-End

Table of Contents

• Deployed App
• Local Deployment
• Dev Team
• Description
• Rock & Pebble Feature
• Agile Development
• Technologies & Architectures
• React & Redux Tutorial
• Testing & Performance
• PostgreSQL Schema
• GraphQL Endpoints
• Resource Credits

Deployed App

Vist the deployed Paired app at https://www.paired.tech.

Local Deployment

See this Deployment Guide for detailed instructions on how to deploy the app in a local environment.

Dev Team

Paired 2.0's dev team:

• Carleigh Crockett (@Capleugh, LinkedIn)
• Daniel Frampton (@DanielEFrampton, LinkedIn)
• Matt Simon (@msimon42, LinkedIn)
• Rebecca Robran (@rer7891, LinkedIn)

Rock & Pebble feature's dev team:

• Rebecca Robran, BE/FE (@rer7891, LinkedIn)
• Rachel Lew, BE (@rlew421, LinkedIn)
• Matt Simon, BE (@msimon42, LinkedIn)
• Linda Le, BE (@linda-le1, LinkedIn)
• Daniel Frampton, BE/FE (@DanielEFrampton, LinkedIn)
• Caleb Haizlett, FE (@CHaiz15, LinkedIn)

Description

This repo contains the Paired 2.0 Back-end, a GraphQL API built with Ruby on Rails and PostgreSQL. It provides data, logic, and other services to a React/Redux Front-end (paired-fe), and communicates with a Flask micro-service which handles SMS text notifications (paired-sms).

Together, these micro-services facilitate paired programming and peer mentoring between Turing students throughout their seven-month immersive program. Students later in the program can create available booking slots, and students earlier in the program can browse those and book paired sessions.

Paired 2.0 was built by a team of students in Turing's Back-End Engineering program. It adds SMS and email notifications of bookings and a user statistics dashboard to the original Paired app (front-end repo, back-end repo) which was built by Front-end students in April of 2019. They graciously allowed contributions to the app and were helpful throughout this process.

Rock & Pebble Feature

The Rock & Pebble feature adds the ability for Paired users to offer to be peer mentors, search for and request peer mentors, and manage their mentors/mentees. Building on the previous 2.0 work, it sends descriptive email notifications throughout the process. By adding this feature we hope to support the grassroots tradition at Turing of upper-module students ("rocks") being partnered with lower-module students ("pebbles") to support their journey.

The Rock & Pebble feature was developed over the course of 2020 by a group of 1909 back-end and front-end graduates, some from the Paired 2.0 dev team and some new contributors. The development took place on forks of the BE and FE repos, which are now archived but can be found here and here respectively for future reference.

Agile Development

Paired 2.0 was developed over the course of 9 days using accelerated agile practices. After an initial proposal was written by the project lead, the team collaboratively participated in an "inception" process. After writing problem and solution statements, the team "brain-dumped" all their feature proposals then went through a feature prioritization process in order to determine which would be part of the "minimum viable product" (MVP).

Soon thereafter the team had a "DTR" meeting to establish goals, communication plans, project management conventions, and more. It was agreed upon that the team would use a Kanban system for project management using Github Projects, and have daily stand-up meetings and weekly retrospective meetings. The team met with a project manager every three days for check-ins and communicated with her regularly via Slack.

Technologies & Architecture

• Hosting: Firebase (FE) and Heroku (BE, SMS)
• Database: PostgreSQL
• Front-end: React & Redux
• Back-end: Ruby on Rails
• SMS Micro-service: Flask & Python
• Testing: Jest (FE), RSpec (BE), and PyTest (SMS)
• GraphQL: Apollo Client (FE) and GraphQL-Ruby (BE)
• OAuth: Github via Firebase
• SMS Notifications: Twilio
• Email Notifications: Sendgrid
• Background Workers: Sidekiq and Redis
• Performance Tracking: Skylight

React & Redux Tutorial

As a team of back-end engineers, stepping into a JavaScript-heavy tech stack was an incredible and bewildering learning experience. To help share that learning with our fellow students in the back-end program, we wrote this tutorial: Explain It Like I'm a Back-ender: React and Redux.

Testing & Performance

At date of project completion, the Paired 2.0 back-end service has 98% test coverage and all tests passing. Server performance and load times are monitored using Skylight, and at time of writing responses average 37 ms.

PostgreSQL Schema

Users	Data Type	Keys
Id	ID	Primary Key
name	String
program	String
pronouns	String
mod	Integer
slack	String
email	String
phone_number	String
firebase_id	String	OAuth Token

Pairings	Data Type	Keys
Id	ID	Primary Key
pairer_id	Integer	User Foreign Key
pairee_id	Integer	User Foreign Key
date	String
time	String
notes	String

Skills	Data Type	Keys
Id	ID	Primary Key
name	String
user_id	Integer	User Foreign Key

GraphQL Endpoints

Our GraphQL endpoints fall into three categories: queries, mutations, and filter queries. For detailed examples of all the endpoints and example responses, see our GraphQL Endpoints Guide or click the specific query or mutation below to go its section.

To make live queries to the GraphQL endpoint and see live schema information, setup the back-end using the local deployment instructions and access GraphiQL at http://localhost:3001/graphiql.

• Queries
  • getUser
  • getUserByFirebaseID
  • getUserPairings
  • getUser
  • getPairings
  • getPairing
  • getUserStats
• Mutations
  • createUser
  • updateUser
  • deleteUser
  • createPairings
  • updatePairings
  • deletePairing
  • deletePairings
• Filter Queries
  • getPairing
• Rock & Pebble Queries & Mutations
  • Queries
    • getUserRockAndPebbles
  • Mutations
    • rockOptInOut
    • createRockPebbleRelationship
    • activateRockPebbleRelationship
    • declineRockPebbleRelationship
    • discontinueRockPebbleRelationship
  • Filter Queries
    • findAvailableRocks

Resource Credits

• Architecture chart created with Lucidchart.com
• Technology logos from Worldvectorlogo.com

paired-be's Issues

Write Readme

Fill out the Readme with:

• Local deployment
• Dev team
• History
• Schema (PostgreSQL and GraphQL, with endpoint examples)
• Architecture / Tech Stack

Wireframe new functionality

Create wireframe diagrams of the new user-facing functionality

Create 'deletePairings' GraphQL mutation endpoint

Stats User Story

As a User,
When I visit my Account Details
And I click "View Stats"
Then I should be on /stats-profile

And I should see the following:

User Name
Total Bookings (total number of paired sessions)
Total Mentor Hours (time you spent mentoring, assume 1/2 hr. sessions)
Total Hours Mentored (time you spent being mentored, assume 1/2 hr. sessions)
List of Mentees

Create 'getAvailablePairings' GraphQL query endpoint

Create 'getUserPairings' GraphQL query endpoint

Create PORO to handle generation of body of SMS notification

Figure out how to import MongoDB data into PostgreSQL

Using the JSON files provided by Jeo

Learn how to use Jest test suite for FE and get tests passing in conjunction with our BE

FE Query Updates

[ ] User Mutations - need to change user: { } to input: { } and wrap other mutation inputs in input: {}

Change config settings to point to deployed apps

In FE, change src/utils/index.js:2 to point to live GraphQL endpoint

Create 'getPairing' GraphQL query endpoint

Create 'getPairings' GraphQL query endpoint

Create 'createUser' GraphQL mutation endpoint

Change mod from string to integer

Create 'deletePairing' GraphQL mutation endpoint

Set up mailer for booking notification as background worker

Edit Profile Phone Number Field

As a logged-in user,
When I visit the root path,
And I click on my profile picture,
And I click on "Edit Profile,"
I see a form that includes a phone number field which is required.
When I fill in the form and input a valid 10 digit US phone number,
and click "Submit,"
then I'm taken to the schedule page.

When I fill in the form and input no phone number or incomplete phone number,
I am returned to the form
and I see an error message "You must provide a valid U.S. phone number."

Create 'createPairings' GraphQL mutation endpoint

Complete GraphQL Tutorial

Martian Chronicles

Create Firebase Query Test

Decide on database after conferring with Alex

Need to decide between PostgreSQL and MongoDB; at stake is whether or not we can import the existing MongoDB data to PostgreSQL (or how challenging it would be).

Create models and relationships

• Create User model with self-referential foreign keys on Pairings
• Create Pairings model
• Create Skills model with relationship to Users

Create database and tables

• Create PostgreSQL database
• Create Users table
• Create Pairings table
• Create Skills table

Factory Bot

Add all resources to factory bot for testing

Create 'getUser' GraphQL query endpoint

Set up GraphQL in Rails

Create 'updateUser' GraphQL mutation endpoint

Create Twilio integration in Flask service

Setup Heroku deployment

Create 'getUserByFirebaseID' GraphQL query endpoint

Prerequisite: #44

Test and Document Flask Microservice

Profile Create Phone Number Field

As a visitor,
When I visit the root path,
And I authenticate using GitHub,
I see a form that includes a phone number field which is required.
When I fill in the form and input a valid 10 digit US phone number,
and click "Submit,"
then I'm taken to the schedule page.

When I fill in the form and input no phone number or incomplete phone number,
I am returned to the form
and I see a error message "You must provide a valid U.S. phone number."

Create 'deleteUser' GraphQL mutation endpoint

Create firebaseID field on Users table

Add error messaging to FE Profile container when phone number is not the right format

Create 'updatePairing' GraphQL mutation endpoint

Configure Skylight.io to check performance

Create GraphQL resolvers

Make cards

Create cards for user stories and tasks

Set up Twilio account

Architecture diagram

Create software architecture diagram based on whiteboard sketch

Fix module vs. mod in GraphQL BE

Create service in Rails to send post request to Flask service

SMS Notifications

As a logged-in user,
when I click "Book a Pairing" in the navbar,
and when I select a program, module, and date for which a mentor is available,
and I click "Book Pairing" for a mentor's open time,
and the mentor has provided a phone number,
then the mentor/bookee will receive an SMS notification with:

• the name of the mentee/booker
• the date and time of the booking
• and a link to view their schedule (https://www.paired.tech/schedule)

If the mentor has not provided a phone number,
then the mentor/bookee will receive an email notification with that same information.

Requires completion of:

• #33
• #23
• #48

Create 'getUsers' GraphQL query endpoint

Resolve local deployment issues

There are still some gremlins in the innards of the FE repo, need to flush 'em out

Set up CI/CD

• Set up Travis

Create PR template

https://help.github.com/en/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository

Create GraphQL query endpoint for user stats (getUserStats)