🖋 PenPost 🖋

updated: 05/10/2021

---

Table of Contents

• Introduction
• Features
• Technologies
• Artist Credits
• Contributions
• Authors

---

Introduction

This project comes out of desire to connect people together and bring a sense of nostalgia through penpals. However, we wanted to reinvent the process so a user can add their own flare and experiences to the postcard.

Originally, this project was built as a capstone project through Turing School of Software & Design. See rubric here.

Features

Please visit our website at: https://penpost.github.io/penpost-web/#/

Use the following log-in credentials to try it out yourself! username: chuck@example.com password: pw1234

Please note: this project is actively in development and changes can and may occur daily.

Categories:

• Home Page

• Logging in

• Updating Personal Info

• Creating a Postcard

• Previewing & Sending a Postcard

Home Page

Upon navigating to our landing page, users see our tagline and sign in or up options.

Log In

A user can log in to view their personal dashboard.

Updating

A user can update their personal information on their dashboard

Create Postcard

A user can create their own postcard by add an image url and their personal message

Preview & Send

A user can preview their created postcard & send it. Additionally, they can go back an edit anything without losing their work.

Technologies

• React
• React-Hooks
• Router
• Cypress for Testing
• GraphQL/Apollo
• SASS/SCSS
• HTML
• Eslint
• Hamburger
• React Count Region Selector
• WAVE for accessibility auditing
• Lighthouse for accessibility auditing
• Miro for project planning and wireframing

Artist Credits

Thanks to the following artists from Unsplash:

• @beckyphan

Future Iterations

More specifics about future work or refactoring can be found in this projects GH issues and in the project

Contributions

Thank you Robbie Jaeger for your guidance and patience.

To Contribute

If you'd like to contribute to the code, please complete the following steps:

• clone this repo locally: git clone git@github.com:penpost/penpost-web.git <renameHere>
• GraphQL documentation & endpoints are here
  • This backend was created by our team members through Ruby & Ruby on Rails. Please see their documentation for further details.
• from there please create a new branch following this pattern: git checkout -b initials/<feature/fix/refactor>/focus-of-branch
• cd into your local copy and run npm install
• Use Cypress for testing
• check that the following key-value pair in scripts is in your package.json
• "cypress": "cypress open"
• if not please download Cypress with npm i -D cypress and add the above to scripts.
• contribute as you'd like and push up your work for review Thank you.

Author

Yesi Meza GH	Kelsie Besinger Yeh GH	Jeff Kersting GH	Gabrielle Joyce GH	Adam Etzion GH