https://github.com/2gbeh/shopera

Peddle Technologies - Full-Stack Developer Assessment
https://github.com/2gbeh/shopera

faker-js lucide-icons nextjs14 postgresql prisma radix-ui react react-hook-form sass shadcn-ui tailwindcss tyepscript vercel zod

Last synced: about 2 months ago
JSON representation

Peddle Technologies - Full-Stack Developer Assessment

• Host: GitHub
• URL: https://github.com/2gbeh/shopera
• Owner: 2gbeh
• License: mit
• Created: 2024-04-16T22:12:58.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-07-22T22:17:41.000Z (7 months ago)
• Last Synced: 2024-11-09T02:43:20.782Z (3 months ago)
• Topics: faker-js, lucide-icons, nextjs14, postgresql, prisma, radix-ui, react, react-hook-form, sass, shadcn-ui, tailwindcss, tyepscript, vercel, zod
• Language: TypeScript
• Homepage: https://shopera.vercel.app
• Size: 3.84 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Logo](./public/favicon.png)

# Peddle Technologies - Full-Stack Developer Assessment

[![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue.svg)](https://www.typescriptlang.org/docs/)

[![TailwindCSS](https://img.shields.io/badge/TailwindCSS-3.x-38bdf8.svg)](https://tailwindcss.com/docs/installation)

[![Prisma](https://img.shields.io/badge/Prisma-5.x-0c344b.svg)](https://www.prisma.io/docs/orm/prisma-client/setup-and-configuration/introduction)

[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-16.x-316192.svg)](https://www.postgresql.org/docs/16/index.html)

[![Next JS](https://img.shields.io/badge/Next-black?style=for-the-badge&logo=next.js&logoColor=white)](https://nextjs.org/docs/app/building-your-application/routing/route-handlers)

[![Vercel](https://img.shields.io/badge/vercel-%23000000.svg?style=for-the-badge&logo=vercel&logoColor=white)](https://shopera.vercel.app)

## Installation

```

$ git clone https://github.com/2gbeh/shopera.git

$ cd shopera

$ npm cache clean --force

$ npm install

$ npm run dev

```

## Usage

> Development: (client) http://localhost:3000/ (server) http://localhost:3000/api/

> Production 🚀🚀🚀: (client) http://shopera.vercel.app/ (server) http://shopera.vercel.app/api/

## API Documentation

> #### [Products Resource](<./src/app/(api)/api/products>)

|    Method | Endpoint                             | Query | Body | Summary                            |

| --------: | :----------------------------------- | :---: | :--: | :--------------------------------- |

|       GET | /products                            |       |      | all (ASC order)                    |

|       GET | /products/[product_id]               |       |      | one                                |

|    ⭐ GET | /products/?like=[search]             |   x   |      | search (product, brand or barcode) |

|    ⭐ GET | /products/validate-barcode/[barcode] |       |      | validate upc-12 barcode            |

|      POST | /products                            |       |  x   | add                                |

|     PATCH | /products/[product_id]               |       |  x   | update                             |

|       PUT | /products/[product_id]               |       |  x   | replace                            |

|    DELETE | /products/[product_id]               |       |      | soft delete (trash)                |

| ⭐ DELETE | /products/[product_id]/?undo=true    |   x   |      | undo delete (restore)              |

> #### [Brands Resource](<./src/app/(api)/api/brands>)

|    Method | Endpoint                      | Query | Body | Summary               |

| --------: | :---------------------------- | :---: | :--: | :-------------------- |

|       GET | /brands                       |       |      | all (ASC order)       |

|       GET | /brands/[brand_id]            |       |      | one                   |

|      POST | /brands                       |       |  x   | add                   |

|     PATCH | /brands/[brand_id]            |       |  x   | update                |

|       PUT | /brands/[brand_id]            |       |  x   | replace               |

|    DELETE | /brands/[brand_id]            |       |      | soft delete (trash)   |

| ⭐ DELETE | /brands/[brand_id]/?undo=true |   x   |      | undo delete (restore) |

## Tech Stack Documentation

![Screenshot](./public/tech-stack.png)

## Screenshots

#### Page 1 (Product Listing)

![Screenshot](./public/ui/page-1.png)

#### Page 2 (Edit Product Listing)

![Screenshot](./public/ui/page-2.png)

#### Page 1 - Mobile (Product Listing)

![Screenshot](./public/ui/page-1-mobile.png)

#### Page 2 - Mobile (Edit Product Listing)

![Screenshot](./public/ui/page-2-mobile.png)

## 🏆🏆 [My barcode validation algorithm](./src/server/pipes/product.pipe.ts) 🏆🏆

![Screenshot](./public/upc12-algo.png)

## Known Issues

Added the `.env` file to .gitignore but it did not exclude it, I think it is related to Prisma ORM (not sure).