bloomtech-labs / merch-dropper-fe

Merch Dropper

Deployed URL: https://www.merchdropper.store/ Go to the Contributing section for important info on how to get started on developing.

Contributors

Jennie Van	Daniel Ajadi	Jerris Manning	Marcos Lira	Tristan Boudreau	Wes Jonke

Julie Thrall Stewart	Alison Rebecca Martin	Trevor Swanton	Gus Baden	Erik Ahlgren	Adam Skoog

Jonathan Hanson	Marlon Del Rosario	Zakaria Touzri	Jen Chatier	John Nicholson	George Davila

Landon Turner

Project Overview

Labs 20 Trello Board Labs 22 Trello Board

Product Canvas

Labs 20 UX Design files Labs 22 UX Design files

Merch Dropper aims to solve, for creators and enterpreneurs, the hassle that comes with creating customized merchindize at a small scale. We aim to take the work away from you so you focus on what you do best, to create. We focus on recieveing the orders, shipping, payments collection, and all the nitty gritty for a fee. We are a plug and play one stop shop.

Key Features

• Design Upload
• Instant Product Mockup
• Cloudinary image/product mockup storage functionality
• Easy and secure checkout

Tech Stack

🚫 more info on using badges here -->

Front end built using:

ReactJS

We chose this framework because:

• Most familiarity with React as a FE framework
• Single Page Application
• It is very responsive

axios

enzyme

bootstrap

reactstrap

styled-components

redux

redux-persist

redux-logger

redux-thunk

cloudinary

react-stripe-checkout

react-stripe-elements

Back end built using:

NodeJS

• Having a true relational database will work very well with the data we expect to be using.
• Everyone on the team has a working knowledge of NodeJS and that'll make it easier to debug if we ever run into any issues.

knex

knex-cleaner

postgreSQL

express

helmet

jsonwebtoken

bycryptJS

APIs

Auth0

Auth0 authentication API allows users to manage all aspects if user identity. It offeres endpoints so your users can log in, sign up, log out , access other API's, and more. The API is designed for people comfortable with integrating RESTful API's.

Stripe

Stripe is a service that allows merchants to accept payments online especially developers. The Stripe API alloes developers to access fucntionality of Stripe. The API is organized around REST; it has predictable resource-oriented URL's, accepts form-encoded requesdt bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The Stripe API has test mode available for ease of development and does not affect live data or interact with any banking networks.

Cloudinary

Cloudinary is an end-to-end image- and video-management solution for websites and mobile apps, covering everything from image and video uploads, storage, manipulations, optimizations to delivery. The Cloudinary API utilizes REST API methods that can be called directly from within your client application or by using one of Cloudinary's SDKs that wrap the REST API and greatly simplify using its methods. Authenticated uploading is done over HTTPS using a secure protocol based on your account's cloud_name, api_key and api_secret parameters.

Scalable Press

The Scalable Press API is a comprehensive REST service for viewing the product catalog, making quotes, and completing orders for the Scalable Press printing and fulfillment services. Requests are made using standard GET, POST, and DELETE requests. All responses are JSON. Once signed up, an API key and a test API key will be provided to the customer to use in their client App. When using the test API key, it works just like the Stripe test API key where no charges are made against the user.

Testing

Jest

Jest is a JavaScript Testing Framework maintained by Facebook, Inc. with a focus on simplicity.

Cypress

Cypress is a JavaScript Testing Framework easier to use and more impactful than Jest because it shows you directly the site being changed and interacted with.

The coverage file will be merch-dropper/coverage/lcov.info and the script used is cypress:coverage. (currently doesn't work due to an error in the github actions which looks like this: level=error msg="failed to read file src/App.js\nopen src/App.js: no such file or directory")

Look in .github/workflows/ci.yml in coverage: to switch things around.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

To develop locally with the Merch Dropper backend, please ensure that you have a .env file with the variable REACT_APP_BASE_URL=development. To create a new user or login locally navigate to [http://localhost:3000/develop]. You will need to clone the BE at [https://github.com/Lambda-School-Labs/Merch-Dropper-be], cd into the project and run yarn run server.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

• Check first to see if your issue has already been reported.
• Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
• Create a live example of the problem.
• Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

• Ensure any install or build dependencies are removed before the end of the layer when doing a build.
• Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
• Ensure that your code conforms to our existing code conventions and test coverage.
• Include the relevant issue number, if applicable.
• You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Backend Documentation for details on the backend of our project.

merch-dropper-fe's Issues

Publish code coverage

Publish code coverage details to Code Climate