Cherrypick14/StarShop-Frontend

StarShop is an Open Source Project designed to empower small businesses and entrepreneurs by providing an easy-to-use marketplace infused with blockchain technology.

โ˜… 0Forks 0GitHub โ†—Compare

README

๐ŸŒŸ StarShop Frontend

StarShop is an innovative platform designed to empower small businesses and entrepreneurs by providing an easy-to-use marketplace infused with blockchain technology. The platform fosters transparency and trust by utilizing Non-Fungible Tokens (NFTs) to create unique digital experiences for customers and businesses alike.


๐Ÿ“ Project Structure

src/
โ”œโ”€โ”€ app/                          # Next.js App Router (routes, layouts, pages)
โ”‚   โ”œโ”€โ”€ layout.tsx
โ”‚   โ”œโ”€โ”€ page.tsx
โ”‚   โ”œโ”€โ”€ not-found.tsx
โ”‚   โ”œโ”€โ”€ buyer/                    # Buyer routes
โ”‚   โ””โ”€โ”€ seller/                   # Seller routes
โ”‚
โ”œโ”€โ”€ features/                     # Business domain modules
โ”‚   โ”œโ”€โ”€ buyer/                    # Buyer logic (faq, profile, cart, ...)
โ”‚   โ”‚   โ”œโ”€โ”€ faq/
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ api/
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ components/
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ hooks/
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ types/
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.ts
โ”‚   โ”‚   โ”œโ”€โ”€ profile/
โ”‚   โ”‚   โ”œโ”€โ”€ cart/
โ”‚   โ”‚   โ””โ”€โ”€ index.ts
โ”‚   โ”‚
โ”‚   โ”œโ”€โ”€ seller/                   # Seller logic (products, orders, ...)
โ”‚   โ”‚   โ”œโ”€โ”€ products/
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ api/
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ components/
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ types/
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ ...
โ”‚   โ”‚   โ”œโ”€โ”€ orders/
โ”‚   โ”‚   โ””โ”€โ”€ index.ts
โ”‚
โ”œโ”€โ”€ shared/                       # Reusable elements
โ”‚   โ”œโ”€โ”€ components/               # Global UI components (Navbar, Modal, etc.)
โ”‚   โ”‚   โ”œโ”€โ”€ ui/                   # Atoms, Molecules, Organisms
โ”‚   โ”‚   โ””โ”€โ”€ layout/
โ”‚   โ”œโ”€โ”€ hooks/                    # Reusable hooks (useAuth, useDebounce, ...)
โ”‚   โ”œโ”€โ”€ utils/                    # Pure utility functions
โ”‚   โ”œโ”€โ”€ constants/                # App-wide constants
โ”‚   โ”œโ”€โ”€ types/                    # Global types
โ”‚   โ”œโ”€โ”€ styles/                   # Global styles (globals.css)
โ”‚   โ””โ”€โ”€ api/                      # General reusable APIs (e.g. login)
โ”‚
โ”œโ”€โ”€ providers/                    # Global context providers
โ”‚   โ””โ”€โ”€ ...
โ”‚
โ”œโ”€โ”€ i18n/                         # Internationalization
โ”‚   โ””โ”€โ”€ i18n.ts
โ”‚
โ”œโ”€โ”€ lib/                          # Non-UI business logic helpers
โ”‚   โ””โ”€โ”€ ...
โ”‚
โ”œโ”€โ”€ index.ts                      # Common exports entrypoint
โ””โ”€โ”€ types.d.ts                    # Global ambient types

๐Ÿš€ Features

  • ๐Ÿ›’ Easy Product Registration: Small businesses can quickly register and start selling their products.
  • ๐Ÿ”— Blockchain Transparency: Builds trust through immutable and transparent blockchain transactions.
  • ๐ŸŽŸ๏ธ NFTs for Purchases: Customers receive a unique NFT for every purchase, serving as a digital collectible tied to the store.
  • ๐Ÿ† Milestone NFTs for Businesses: Businesses earn milestone NFTs based on their sales achievements, showcasing their growth and success.
  • ๐Ÿค Celebrating Growth and Connection: Strengthens the relationship between businesses and customers through a marketplace that values trust, growth, and connection.

โš™ Technologies


๐Ÿ› ๏ธ Getting Started

  1. Clone the repository:
    git clone https://github.com/<your-username>/StarShop-Frontend.git
    cd StarShop-Frontend
  2. Install dependencies:
    npm install
  3. Copy environment variables:
    cp .env.example .env
  4. Start the development server:
    npm run dev

If you encounter installation issues, try:

  • npm cache clean --force
  • rm -rf node_modules
  • rm package-lock.json
  • npm install
  • Or: npm install --legacy-peer-deps

๐Ÿค Contributing

We welcome contributions to StarShop! Check out our Contributor's Guide to get started.


โญ Don't forget to Star this repo!!

๐Ÿ‘ค Maintainer

This repository is maintained by KevinLatino.

Contributors

KevinLatinoJoelVR17MPSxDevJosueBrenesaguilar1xJamesVictor-OkimcascanteVillarleyalejandroquerudrakkomaximoElite-tchEmmanuelOlokearmandocodecrresppsasasamaesAkanimorexYourmix0xFrankiePowerksjayasankarlaryhillssalazarsebasPvsaintAntrikshgwalLuluamehvictorbuikemMarvelousmichealJagadeeshftwBenjtalkshowAnoukRImolaJosue19-08

Issues