https://github.com/stynw7/technical_test_shelfnow

Subject Coordinator Technical Test - Software Architecture Project
https://github.com/stynw7/technical_test_shelfnow

docker microservice mysql nestjs prisma react vite

Last synced: 2 months ago
JSON representation

Subject Coordinator Technical Test - Software Architecture Project

Host: GitHub
URL: https://github.com/stynw7/technical_test_shelfnow
Owner: StyNW7
Created: 2025-10-25T06:33:07.000Z (5 months ago)
Default Branch: main
Last Pushed: 2025-11-04T16:55:43.000Z (5 months ago)
Last Synced: 2025-11-04T17:22:41.453Z (5 months ago)
Topics: docker, microservice, mysql, nestjs, prisma, react, vite
Language: TypeScript
Homepage:
Size: 3.7 MB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

ShelfNoW

Subject Coordinator Promotion Technical Test

COSC6093 - Software Architecture

ShelfNoW is a modern online book e-commerce platform designed to provide seamless book browsing, purchasing, inventory management, and user experience through a clean microservice architecture.

---

## 📃 Table of Contents
- [Introduction](#🌟-introduction)
- [Technology Stack](#🛠️-technology-stack)
- [Core Features](#🧩-core-features)
- [Getting Started Locally](#🧰-getting-started-locally)
- [env Configuration](#🔐-env-configuration)
- [Screenshots](#🖼️-screenshots)
- [Satzinger’s Diagram](#🧭-diagrams)
- [Owner](#👥-owner)
- [Contact](#📬-contact)

---

## 🌟 Introduction
**ShelfNoW** is an online bookstore platform that allows users to browse, search, and purchase books with an intuitive and efficient interface.
The system is designed using clean architecture, separating concerns between presentation, domain logic, and data persistence, ensuring scalability and maintainability.

It also includes an admin dashboard for managing books, orders, users, and categories.

> "Bringing seamless reading discovery and book shopping to a modern digital space."

---

## 🛠️ Technology Stack
- **Frontend**: React with Vite, TypeScript, TailwindCSS, ShadcnUI components
- **Backend**: NestJS with Microservice Architecture
- **Database**: MySQL with Prisma ORM
- **Dockerize**: Docker and docker-compose
- **Tools**: Git and GitHub

---

## 🧩 Core Features

- **👤 User Account System** — Register, Login, and View Order History
- **🧺 Shopping Cart** — Add/Remove/Update Cart Items
- **🛒 Book Browsing & Discovery** — User can search and checkout books.
- 👥 **Role-Based Access Control** — Different user roles: Guest, Customer, and Admin
- 🔐 **Authentication & Authorization** — JWT-based login system for session management. There is also Middleware
- **📦 Admin Inventory Management** — Admin can do CRUD for the Books Inventory Management

---

## 🧰 Getting Started Locally

### Prerequisites
- **Node.js** (v18 or higher)
- **Docker or WSL**
- **Git**

### Clone (Setup Locaclly)
```bash
git clone https://github.com/StyNW7/Technical_Test_ShelfNoW.git
cd Technical_Test_ShelfNoW
```

### Start and Stop Docker
```bash
docker-compose up --build
docker-compose down
```

---

## 🔐 .env Configuration

Default MySQL Server Port is: 3306 (But, you can check it manually)
```
# API GATEWWAY ENVIRONMENT VARIABLES

PORT=3001
JWT_SECRET=
JWT_EXPIRES_IN=3600s

# AUTH SERVICE ENVIRONMENT VARIABLES

PORT=3001
JWT_SECRET=
JWT_EXPIRES_IN=3600s

DATABASE_URL=mysql://root:root@mysql:3306/shelfnow_auth_db
DATABASE_HOST=mysql
DATABASE_PORT=3306
DATABASE_USER=root
DATABASE_PASSWORD=root
DATABASE_NAME=shelfnow_auth_db
NODE_ENV=development

# ORDER SERVICE ENVIRONMENT VARIABLES

PORT=3003
JWT_SECRET=
JWT_EXPIRES_IN=3600s

DATABASE_URL=mysql://root:root@mysql:3306/shelfnow_order_db
DATABASE_HOST=mysql
DATABASE_PORT=3306
DATABASE_USER=root
DATABASE_PASSWORD=root
DATABASE_NAME=shelfnow_order_db
NODE_ENV=development

# PRODUCT SERVICE ENVIRONMENT VARIABLES

PORT=3002
JWT_SECRET=
JWT_EXPIRES_IN=3600s

DATABASE_URL=mysql://root:root@mysql:3306/shelfnow_product_db
DATABASE_HOST=mysql
DATABASE_PORT=3306
DATABASE_USER=root
DATABASE_PASSWORD=root
DATABASE_NAME=shelfnow_product_db
NODE_ENV=development

# FRONTEND ENVIRONMENT VARIABLES

VITE_API_URL=http://localhost:3000
```

📌 You can create these files manually or copy from a provided `.env.example` file (recommended). Make sure to make the .env file for each service

---

## 🖼️ Screenshots

*Landing Page*