From cce97a207184d46340251c1f124af5cc21b2dba6 Mon Sep 17 00:00:00 2001 From: Aswajith S <139551991+Aswajith7077@users.noreply.github.com> Date: Mon, 6 Oct 2025 08:24:31 +0530 Subject: [PATCH] Update README.md --- README.md | 68 ------------------------------------------------------- 1 file changed, 68 deletions(-) diff --git a/README.md b/README.md index e4d94cd..8b13789 100644 --- a/README.md +++ b/README.md @@ -1,69 +1 @@ -# Shopnex - -[![Repo Type](https://img.shields.io/badge/Repo-Monorepo-blue)](#) -[![Frontend](https://img.shields.io/badge/Frontend-React-%2361DAFB)](#) -[![Backend](https://img.shields.io/badge/Backend-FastAPI-%23009688)](#) -[![Database](https://img.shields.io/badge/Database-MongoDB-%2347A248)](#) -[![Containerized](https://img.shields.io/badge/Container-Docker-%232496ED)](#) -[![License](https://img.shields.io/badge/License-Proprietary-red)](#license) - - ---- - -## Overview - -**Zevrin** is a **mono repository** containing both the backend and frontend codebases for an online marketplace where buyers, sellers, and dealers can trade consumer goods on a common platform. - -The system integrates **credit scores** to enable trust-based transactions and provides dealer profiles so users can connect with top-rated dealers. - -Built with **FastAPI**, it follows the **MVC architecture** for maintainability, uses **MongoDB** for storage, and **JWT authentication** for secure access. -Fully containerized with **Docker**, it can be deployed easily on any compatible environment. - ---- - -## Features - -* **Trading Platform** – Connect buyers, sellers, and dealers. -* **Credit Score Integration** – Trust-based transactions. -* **Dealer Profiles** – View top dealers and their details. -* **MVC Architecture** – Clean and scalable project structure. -* **JWT Authentication** – Secure login and access control. - ---- - -## Tech Stack - -* **Frontend**: React -* **Backend**: FastAPI -* **Database**: MongoDB -* **Containerization**: Docker - ---- - -## Project Structure - -``` -Zevrin/ -│── frontend/ # React frontend -│── backend/ # FastAPI backend -│ ├── app/ # Application code (MVC) -│ ├── models/ # Data models -│ ├── services/ # Business logic -│ ├── requirements.txt -│ ├── Dockerfile -│ ├── .env.example -``` - ---- - -## Author - -Developed by [Aswajith S](https://github.com/Aswajith7077) - ---- - -## License -© 2025 Aswajith S. All rights reserved. -This project is proprietary software. Unauthorized use, copying, modification, or distribution is prohibited. -