US Postal & Printing

Description

US Postal & Printing is a full stack MERN web app that serves as an information page for the company US Postal & Printing. The user is able to see the services the company provides, track packages, make orders, contact the store, and save orders and packages to their dashboard. For more information check out the PowerPoint.

The project utilizes an Express backend, GraphQL Api, mongoDB database, and a third party Api.

While building this project we learned to:

• Style a page with Material UI, a css component library
• Make a proxy server using Axios in order to circumvent CORS errors
• Authenticate users via JSON Web Tokens
• Link to another page without reloading the website using React

MERN Stack

Tech

Table of Contents

• Installation
• Usage
• Contributing
• License
• Contact & Contributors

Installation

US Postal & Printing is a deployed web application. Most users must simply navigate to us-postal-printing.herokuapp.com/

Should you wish to download the project locally you must:

1. Open your terminal and clone the repo

   SSH:
   git clone [email protected]:Mateo-Wallace/US-Postal-Printing.git
   
   HTTPS:
   git clone https://github.com/Mateo-Wallace/US-Postal-Printing.git
   

2. Install NPM packages

   npm i
   

3. Rename the .env.example file in /server to .env and change the variables

   SHIPPO_AUTH = "ShippoToken <YOUR API KEY FROM SHIPPO>"
   

(back to top)

Usage

When navigating to the website you will be greeted with the home page. This page displays relevant services, carrier pickup times, and business hours. At the top of the screen you will see a NavBar. Clicking on the following links will result in the subsequent action:

• Logout: Cancel user session
• Products & Services: In depth information on available services
• Make An Order: Form with various inputs, information is saved to database
• Tracking: Type in a tracking number for USPS, UPS, Fedex, or DHL. If you are logged in you may also save this number to your packages in Dashboard
• DashBoard: Relevant data to the current logged in user
  • View My Packages: Shows saved packages and allows user to update and delete
  • View My Orders: Shows saved orders and allows user to update and delete
  • Edit My Account: Shows user data and allows user to update and delete
• Contact Us: Form that is emailed to the business owner on submit

(back to top)

Contributing

If you have a suggestion that would make the repo better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact And Contributors

For any further questions feel free to contact us via:

• Project Link: github.com/Mateo-Wallace/US-Postal-Printing

• Dylan Crowley - GitHub - Email - LinkedIn

• Benjamin Fein - GitHub - Email - LinkedIn

• Sangki Jun - GitHub - Email - LinkedIn

• Mateo Wallace - GitHub - Email - LinkedIn

(back to top)