Skip to content

Latest commit

 

History

History
89 lines (55 loc) · 4.34 KB

README.md

File metadata and controls

89 lines (55 loc) · 4.34 KB

svd-client-sample

This is a code sample extracted from the source code of my former React/Next.js E-commerce website selling digital products. The website was designed after popular digital asset bundle marketplaces.

Live Demo

The code sample includes only the bundle pages (pages showcasing individual graphic products), as well as the FAQ, About and Contact pages.

Table of Contents

Demo Limitations
Project Packages and Components
Project Structure and Code Style
How to Run the App

Demo Limitations

  • The current demo has only bundle pages. The original website also had pack and image pages, 70000 of procedurally generated pages in total.

  • Instead of using the previous AWS S3-compatible image storage, I placed the images used in this demo in the public/cdn folder. Using a regular CDN would considerably improve the website's performance.

Project Packages and Components

This project uses

  • React + Next.js (for server-side rendering and static page generation).

  • React Bootstrap (for Bootstrap grid and navigation bar component with custom styling).

  • SCSS (mostly variables and mixins + a few functions) with CSS modules for styling. The project has responsive UI with custom styling.

  • React hooks, including standard hooks (useEffect, useState, useCallback) and custom hooks (useIsHovered, useIsMounted, available in the hooks folder). The useState hook is used to store page-specific state.

  • The original website integrated Paddle for checkout. In the sample app, I use Redux to store checkout cart contents, redux-persist to persist the Redux store locally, and redux-state-sync to synchronize the Redux state across different browser tabs.

  • a custom inline image gallery component with thumbnails. Third-party image gallery solutions did not fit my design concept, so I rolled out a fast gallery solution based on existing image galleries used on digital asset marketplaces.

Clicking on the large image preview in the inline image gallery opens the image directly in the browser.

  • Jest tests were removed from the project because of conflicts between old Jest setup and new Next.js config.

Project Structure and Code Style

Components are arranged by folders:

  • pages - app routes (Next.js routing is filesystem-based). They render top-level route-specific components and export getServerSideProps functions (for example, in pages/bundle/[slug].js) to enable server-side rendering.

  • src

    • components - app components.
      • assets - inline SVG icons.
      • common - components, used often and on multiple pages, but not on all pages.
      • dialogs - modal dialogs/popups.
      • pages - route-specific components.
      • shared - components, present on all (or almost all) pages, like app navigation bar and footer.
    • constants - help avoid using "magic" strings and numbers.
    • data - hardcoded data for preview purposes.
    • hooks - custom hooks.
    • redux - global Redux store, Redux slices (which are organized by feature folders and contain feature-specific initial state, actions, reducers, and selectors), and custom dummy server-side storage.
    • styles - global app styles.
    • utils - small focused utility functions for working with strings, arrays, data etc.

Imports in each module are organized by categories (such as React, Next.js, regular components, common and shared components, utility functions, and styles) and alphabetically within each category, based on module names and imported items.

Exported constants use UPPER_SNAKE_CASE, while local constants use camelCase. Object constants are named in the singular form, array constants in the plural form, and the keys of object constants are written in camelCase.

How to Run the App

Please install or update npm command-line utility.

cd in Terminal to the app's root directory (where package.json file is located) and run npm install to install the packages.

To run the development build (slow, with debugging info and hot module reloading on code change), run

npm run dev

To run the production build locally, run

npx next build
npx next start

Then open http://localhost:3000/ in your browser.

Demo

Live Demo