MerchOS

You can find the deployed project at Heroku.

Contributors

Alberto Galvan	Austin Lynes	Brandon Nichols	Brandon Davis

Chris Ksiazak	Igor Tavarez	Jake Butler	Taylor Blount

Project Overview

Trello Board

Product Canvas

UX Design files

The fastest, most hassle free way to set up a merch shop. It's a platform to build your store, upload your design, and create products, all while plugging into scalablepress.com to drop ship your product.

Key Features

• Drag and Drop store builder
• Hassle free product creator
• Easy payment options
• Analytics
• Free to build

Tech Stack

Front end built using:

NextJS

• Server Side Rendering
• Architecture flow
• SEO

Redux + Redux Persist + Redux Thunk

• Centralized State management
• Maintainability
• Predictable state
• Asynchronous actions
• Persistence

Styled Components

• Style freedom
• Scoped styles
• Server Side Rendering
• Variable props

Front end deployed to https://merchos-fe.herokuapp.com/

Back end built using:

Nodejs/express

• Simplified HTTP server
• Pure Javascript
• NPM access
• Middleware

bcryptjs

• One way hashing
• Salting
• Random salt for each request

jsonwebtoken

• Authentication
• Authorization
• Validation

knex

• SQL queries in JS
• Database migrations and seeding
• Database control

postgres

• Relational data management
• Data integrity

APIs

Scalablepress.com

Scalablepress allows us to hook into their drop shipping service by creating the merchandise requested by our end user. This allows the user to submit a product, receive a quote, and place a purchase. Payments are accepted via Paypal.

Environment Variables

In order for the app to function correctly, the user must set up their own environment variables. There should be a env file containing the following:

   BACKEND_URL: 'Enter URL to server'

Content Licenses

Image Filename	Source / Creator	License

Testing

Cypress

Installation Instructions

1. Clone this repository to your local machine

   git clone https://github.com/Lambda-School-Labs/merchos-fe.git
   

2. Once downloaded, enter the project directory

3. With your package manager of choice, install the dependencies

   • yarn install or npm install

4. Start the client

   • yarn dev or npm run dev

Other Scripts

* dev - creates a dev build of the application (refreshes upon update)
* build - builds the application
* start - starts an instance of the application
* cypress - initializes the cypress testing suite

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.

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.