README.md

Red Paperclip

Table of Contents

1. Contributors
   • Rebekah Cruz
   • Cory Ellerbroek
   • William Fink
   • Blake Hughes
   • Travis Morse
   • Matthew Sewell
   • Pingping Xiao
2. Project Overview
   • Tech Stack
3. Getting Started
   • Prerequisites
   • Installation
4. Module Break Down
5. Acknowledgements

Introduction

Red Paperclip was a collaborative Full-Stack project between the 7 collaborators. This was a brief 1-week sprint that simulated the real-world development of a Full-Stack web application to the demands provided by the client.

Contributors

Rebekah Cruz

[email protected]

UI Owner/Software Engineer

Cory Ellerbroek

[email protected]

Project Manager/Software Engineer

William Fink

[email protected]

Blake Hughes

[email protected]

UI Owner/Software Engineer

Travis Morse

[email protected]

UI Owner/Software Engineer

Matthew Sewell

[email protected]

Architecture Owner/Software Engineer

Pingping Xiao

[email protected]

Architecture Owner/Software Engineer

Team Member Expectations and Workflow:

• Communicated their progress in daily standups
• Created and completed their task tickets using Trello
• Brainstormed and reflected the teams work in 2 day mini-sprints

Project Overview

This project was a brief 1-week sprint where our team tried to complete an MVP for a client. The client provided the following guidance:

"I’d like to create an app that’s called "Red Paperclip", where users can post an item that they have to trade in exchange for an item that someone else has posted (ie. A user has a red paperclip, and hopefully someone else has something they're willing to trade for that red paperclip) Multiple users should be able to post their items, but each user should only have one item posted at a time. A feed should display all items and each user should have a personal page that tracks everything you’ve traded so far. The users should be able to chat about their items before confirming the trade. I would like an admin dashboard to moderate the page"

Tech Stack

• React
• MaterialUI
• Axios
• Express
• Firebase
• Webpack

Getting Started

To explore the project, follow the instructions below.

Prerequisites

• npm

  npm install

Installation

1. Navigate to the main red-paperclip folder and install the local dependencies:

   npm i
   

2. Open a seperate terminal and navigate to the firebase/functions folder and install the local dependencies:

   npm i
   

3. Install the firebase tools globally:

   npm i -g firebase-tools
   

4. Logging into firebase, from the firebase/functions folder run:

   firebase login
   

5. Start webpack and have it listen for changes. From the red-paperclip folder run:

   npm run watch
   

6. To launch locally, from the firebase/functions folder run:

   firebase serve
   

7. To deploy, from the firebase/functions folder run:

   firebase deploy --only hosting
   

Application Demo

Acknowledgements

• NodeJS
• Img Shields
• dateformat
• @react-google-maps/api
• dotenv
• process