Skip to content

Commit

Permalink
docs: feature screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
spencerlepine committed Nov 1, 2024
1 parent 97f5c00 commit 2d17f2c
Show file tree
Hide file tree
Showing 8 changed files with 1,381 additions and 31 deletions.
Binary file added .github/feature-blank.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/feature-catalog-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/feature-checkout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/feature-view-product.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1,363 changes: 1,363 additions & 0 deletions .github/swagsticker-system-diagram.excalidraw

Large diffs are not rendered by default.

Binary file added .github/swagsticker.com-system-diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 4 additions & 3 deletions .github/workflows/manual-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
name: Manually Deploy

on:
push:
branches:
- main
workflow_dispatch:
# push:
# branches:
# - main

jobs:
#bootstrap:
Expand Down
42 changes: 14 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# SwagSticker.com ![Repo Status Badge](./.github/status-maintained-badge.svg)

E-commerce store for developer laptop stickers, fully autonomous and scale-abe. Built with Jamstack and server-side rendering.
Full-stack e-commerce store for developer laptop stickers. Automated with dropshipping

<img width="800px" style="margin:auto" src="./.github/swagsticker.com-screenshot.png" alt="SwagSticker.com website screenshot">
https://github.com/user-attachments/assets/d32962b3-6aa8-401c-ab43-440fff3e31cc

## 🎥 Demo Video

https://github.com/jadiaheno/vention-machine-cloud-test/assets/13062328/a42d55bb-0381-4d16-9ea3-24aced02e5d3
<img width="800px" style="margin:auto" src="./.github/swagsticker.com-system-diagram.png" alt="SwagSticker.com system diagram">

## 🎯 Project Overview

Expand All @@ -28,42 +27,29 @@ https://github.com/jadiaheno/vention-machine-cloud-test/assets/13062328/a42d55bb
- **Framework**: Next.js (React), TailwindCSS
- **Language**: TypeScript
- **Hosting**: Vercel (w/ Amazon Route53 domain)
- **Third-Party**: Stripe (payments), Printify (drop-shipping)
- **Third-Party**: Stripe SDK (payments), Printify SDK (drop-shipping)

> **Specifications:**
>
> - Node.js: >=v20
> - React.js: v18
> - Next.js: v14 (App Router)
> - Vercel: serverless, hobby plan
## 🏗️ System Diagram
## ⭐️ Features

<!-- TODO_README -->
<!-- ![Onboarding Feature](./TODO_README) _Users can use guest mode, or register/login._ -->

![SwagSticker.com system diagram](./.github/swagsticker.com-system-diagram.png)
![Catalog Feature](./.github/feature-catalog-search.png) _Browse the catalog, filter by category, and sort._

## ⭐️ Features
![View Product Feature](./.github/feature-view-product.png)_Add item to cart, proceed to checkout._

<!-- TODO_README -->
![Checkout Feature](./.github/feature-checkout.png) _Place order and checkout with secure embedded Stripe form, optimized for conversions._

- <auth feature no pass, or stay guest>
- <browse the catalog, search, filter>
- <add items to cart, proceed to checkout>
- <use secure stripe form, place order>
- <track shipping status>
<!-- ![Account Page Feature](./.github/TODO_README) _View orders, download receipts, and track shipping status._ -->

## 💻 Local Development

📌 Note: this demo can be run locally; the production code is private for security reasons

#### Prerequisites

- **Node.js** installed on your machine (download [here](https://nodejs.org/en/download))
- Stripe developer account (+ API keys)
- `stripe-cli` (`$ brew install stripe/stripe-cli/stripe`)
- Whitelisted endpoints for Stripe webhook (`https://website.com/api/v1/webhook/checkout`)
- Printify developer account (+ API keys)
- [Stripe](https://stripe.com) developer account (+ API keys)
- [stripe-cli](https://github.com/stripe/stripe-cli) (`$ brew install stripe/stripe-cli/stripe`)
- Whitelisted endpoints for [Stripe](https://dashboard.stripe.com) webhook (`https://website.com/api/v1/webhook/checkout`)
- [Printify](https://printify.com) developer account (+ API keys)

#### Installation

Expand Down

0 comments on commit 2d17f2c

Please sign in to comment.