https://github.com/th3y3m/e-commerce-platform

https://github.com/th3y3m/e-commerce-platform

casbin go gorm nextjs14 postgresql

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/th3y3m/e-commerce-platform
• Owner: th3y3m
• License: other
• Created: 2024-09-09T04:33:44.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-09-19T08:06:26.000Z (about 2 months ago)
• Last Synced: 2024-09-19T11:02:38.548Z (about 2 months ago)
• Topics: casbin, go, gorm, nextjs14, postgresql
• Language: Go
• Homepage:
• Size: 447 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
[![CodeQL](https://github.com/th3y3m/e-commerce-platform/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/th3y3m/e-commerce-platform/actions/workflows/github-code-scanning/codeql)

[![E-Commerce Platform (CI applid)](https://github.com/th3y3m/e-commerce-platform/actions/workflows/ci-script.yml/badge.svg)](https://github.com/th3y3m/e-commerce-platform/actions/workflows/ci-script.yml)

![MIT License](https://img.shields.io/badge/License-MIT-yellow.svg)

# Welcome to E-Commerce Platform in Go

This project is an e-commerce platform built using Go, leveraging a range of powerful libraries and services to handle various aspects of the application, including user authentication, payment processing, product management, and more.

![Go](https://img.shields.io/badge/Go-00ADD8?style=for-the-badge&logo=go&logoColor=white)

![GORM](https://img.shields.io/badge/GORM-7289DA?style=for-the-badge&logo=postgresql&logoColor=white)

![Gin](https://img.shields.io/badge/Gin-00ADD8?style=for-the-badge&logo=go&logoColor=white)

![PostgreSQL](https://img.shields.io/badge/PostgreSQL-336791?style=for-the-badge&logo=postgresql&logoColor=white)

![Google Cloud](https://img.shields.io/badge/Google_Cloud-4285F4?style=for-the-badge&logo=google-cloud&logoColor=white)

![JWT](https://img.shields.io/badge/JWT-black?style=for-the-badge&logo=JSON%20web%20tokens)

![Casbin](https://img.shields.io/badge/Casbin-7289DA?style=for-the-badge&logo=casbin&logoColor=white)

![Goth](https://img.shields.io/badge/Goth-FF4088?style=for-the-badge&logo=goth&logoColor=white)

![Redis](https://img.shields.io/badge/Redis-DC382D?style=for-the-badge&logo=redis&logoColor=white)

![RabbitMQ](https://img.shields.io/badge/RabbitMQ-FF6600?style=for-the-badge&logo=rabbitmq&logoColor=white)

---

  Table of Contents

  


    
Features

    
Technologies Used

    
Screenshots

    
Contact Us

  


---

## 🚀 Features

- **User Authentication**: Supports Google and Facebook authentication via `goth`, alongside email and JWT authentication.

- **Storage**: Uses Google Cloud Storage for storing product images and other media files.

- **RBAC Authorization**: Implements Role-Based Access Control (RBAC) using `casbin` to manage user permissions efficiently.

- **Task Scheduling**: Utilizes `gocron` for scheduling and managing periodic tasks such as promotions, product updates, etc.

- **Database Management**: Powered by GORM with PostgreSQL as the primary database for storing user data, products, and orders.

- **Session Management**: Uses `gin-contrib/sessions` for secure session handling.

- **Custom Product UUIDs**: Generates unique identifiers for products using `google/uuid`.

- **Configuration Management**: Environment variables are managed using `godotenv` for easier configuration.

- **Caching**: Implements Redis for caching frequently accessed data.

- **Message Queue**: Uses RabbitMQ for handling asynchronous communication between services.

## 🛠️ Technologies Used

- **Backend Framework**: `gin` (A lightweight web framework in Go).

- **Database**: PostgreSQL with `gorm` for ORM.

- **Authentication**: `goth` for Google and Facebook OAuth, `jwt-go` for JWT tokens.

- **Storage**: Google Cloud Storage for media assets.

- **Scheduling**: `gocron` for background tasks.

- **RBAC Authorization**: `casbin` for role-based access control.

- **Unique Identifiers**: `google/uuid` for generating UUIDs.

- **Caching**: `redis` for caching.

- **Message Queue**: `RabbitMQ` for message queue management.

- **Unit Test**: `testify` for Unit Test.

## 📸 Screenshots

(Screenshots coming soon...)

## Requirements

- Go 1.23.0 or above.

- PostgreSQL database.

- Google Cloud credentials for Cloud Storage.

- OAuth credentials for Google and Facebook authentication.

- Redis server for caching.

- RabbitMQ server for message queues.

## Installation

1. **Clone the repository**:

    ```bash

    git clone https://github.com/th3y3m/e-commerce-platform.git

    cd e-commerce-platform

    ```

2. **Install Go dependencies**:

    ```bash

    go mod download

    ```

3. **Set up environment variables** by creating a `.env` file in the root directory:

    ```bash

    touch .env

    ```

4. **Run the application**:

    ```bash

    go run main.go

    ```

## Modules & Libraries

- **Gin**: Web framework for building the HTTP server and RESTful APIs.

- **GORM**: ORM library for database management.

- **Casbin**: Authorization library for role-based access control (RBAC).

- **JWT-Go**: For creating and verifying JWT tokens.

- **Google Cloud Storage**: For storing media files.

- **GoCron**: For scheduling tasks.

- **Goth**: For Google and Facebook OAuth.

- **Redis**: For caching frequently used data.

- **RabbitMQ**: For message queue management.

- **Godotenv**: For environment variable management.

- **UUID**: For generating unique product and order IDs.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

## 📬 Contact Us

For inquiries or support, reach out via [[email protected]](mailto:[email protected]).

---

##### © 2024 th3y3m