Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/marcin-niewczas/myshop-api

myShop E-Commerce & CMS REST API | ASP.NET Core Web API
https://github.com/marcin-niewczas/myshop-api

api-rest asp-net-core asp-net-core-web-api clean-architecture cms cqrs csharp e-commerce entity-framework-core jwt-authentication management-panel mssql order-management orders product-management product-variant-options product-variants products refresh-tokens swagger

Last synced: about 1 month ago
JSON representation

myShop E-Commerce & CMS REST API | ASP.NET Core Web API

Host: GitHub
URL: https://github.com/marcin-niewczas/myshop-api
Owner: marcin-niewczas
License: mit
Created: 2024-07-10T12:39:56.000Z (8 months ago)
Default Branch: main
Last Pushed: 2024-08-06T12:57:33.000Z (7 months ago)
Last Synced: 2025-01-18T12:16:08.415Z (about 1 month ago)
Topics: api-rest, asp-net-core, asp-net-core-web-api, clean-architecture, cms, cqrs, csharp, e-commerce, entity-framework-core, jwt-authentication, management-panel, mssql, order-management, orders, product-management, product-variant-options, product-variants, products, refresh-tokens, swagger
Language: C#
Homepage:
Size: 369 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

myShop API

## Table of Contents
1. **[About The Project](#about-the-project)**
- **[Features](#features)**
- **[Built with](#built-with)**
2. **[Related Projects](#related-projects)**
3. **[Getting Started](#getting-started)**
4. **[Launch myShop Projects](#launch-myshop-projects)**
5. **[Authenticate](#authenticate)**
6. **[License](#license)**

## About The Project
The main goal of **myShop API** project was to create a flexible E-Commerce API platform, that can be easily managed. The project has been built as Clean Architecture REST API and developed with CQRS (Command Query Responsibility Segregation), Unit Of Work and Event Driven Architecture Patterns.

### Clients
- **[myShop Angular Client](https://github.com/marcin-niewczas/MyShop-Angular-Client) ( [Screenshots](https://github.com/marcin-niewczas/MyShop-Angular-Client/blob/main/SCREENSHOTS.md)** )

### Features
- **For the entire platform**
- Real time notifications with SignalR,
- User Roles
- Guest
- Customer
- Employee
- Seller
- Manager
- Admin
- SuperAdmin
- Message broker built with Channel
- CRON Jobs,
- Async Background Tasks (e.g. Payment Processing with **[myShop Pay](https://github.com/marcin-niewczas/MyShop-Pay)** )
- **E-Commerce**
- Customized Home Page
- Products List
- Advanced Filtering (by Variant Options, Detail Options, Price)
- Advanced Sorting (e.g. Top Rated, Bestsellers, Most Reviewed Products)
- Group Products By All Variant Options or Main Variant Option
- Product Detail (Single or Product Variants)
- Product Reviews
- Favorites
- Quick Add Product
- Shopping Basket
- Ordering Wizard
- Create Order by Guest
- **Management Panel**
- Dashboard
- E-Commerce Home Page Management
- Categories Management
- Product Options Management
- Product, Product Reviews, Product Variants, Product Photos Management
- Orders Management
- **Account**
- Basic Account Information Management
- User Addresses Management
- User Orders Management
- Notifications List
- Favorite Products Management
- Account Security Management
- **Authenticates**
- JWT Authenticates with Refresh Tokens
- Possibility of sessions on various devices
- Sign In
- Sign Up
### Built with
* .NET 8
* ASP.NET Core Web API
* ASP.NET Core Authentication JWT Bearer
* Entity Framework Core (MS SQL)
* ASP.NET Core SignalR
* Swagger
* Quartz.NET
* Humanizer
* Scrutor

## Related Projects
* **[myShop Angular Client](https://github.com/marcin-niewczas/MyShop-Angular-Client)**
* **[myShop Pay](https://github.com/marcin-niewczas/MyShop-Pay)**

## Getting Started
> [!Important]
> For fully functionality, the **myShop API** project must have **[related projects](#related-projects)** running.
>
> Full instruction for starting **myShop** projects is **[here](#launch-myshop-projects)**.
1. Clone repository
```sh
git clone https://github.com/marcin-niewczas/MyShop-API.git
```
2. Database
- Windows
- Nothing to do, but if you wanna run database via **Docker** go to `Mac OS/Linux` step
- Mac OS/Linux
- Go to `./src/MyShop.API/appsettings.json` and comment `WindowsConnectionString`, then uncomment `DockerConnectionString`
- Run **Docker App**
- In root directory of repository run
```sh
cd ../../
docker-compose up -d
```
3. In root directory of repository run
```sh
dotnet run --project ./src/MyShop.API/MyShop.API.csproj --launch-profile MyShop.HTTPS.Development
```
## Launch myShop Projects
### 1. Clone repositories
```sh
git clone https://github.com/marcin-niewczas/MyShop-API.git
git clone https://github.com/marcin-niewczas/MyShop-Angular-Client.git
git clone https://github.com/marcin-niewczas/MyShop-Pay.git
```

### 2. myShop API
1. Go to root folder of **myShop API** repository
```sh
cd MyShop-API
```
2. Database
- Windows
- Nothing to do, but if you wanna run database via **Docker** go to `Mac OS/Linux` step
- Mac OS/Linux
- Go to `./src/MyShop.API/appsettings.json` and comment `WindowsConnectionString`, then uncomment `DockerConnectionString`
- Run **Docker App**
- In root directory of repository run
```sh
cd ../../
docker-compose up -d
```
3. In root directory of repository run
```sh
dotnet run --project ./src/MyShop.API/MyShop.API.csproj --launch-profile MyShop.HTTPS.Development
```
### 3. myShop Angular Client
1. Go to root folder of **myShop Angular Client** repository
```sh
cd ../MyShop-Angular-Client
```
2. In root folder of repository install NPM packages
```sh
npm install
```
3. Run application
```sh
ng serve
```

### 4. myShop Pay
1. Go to root folder of **myShop Pay** repository
```sh
cd ../MyShop-Pay
```
3. Database
- Windows
- Nothing to do, but if you wanna run database via **Docker** go to `Mac OS/Linux` step
- Mac OS/Linux
- Go to `./MyShopPay/appsettings.json` and comment `WindowsConnectionString`, then uncomment `DockerConnectionString`
4. In root directory of repository run
```sh
dotnet run --project ./MyShopPay/MyShopPay.csproj --launch-profile https
```
## Authenticate
| Email | Password |
| :---: | :------: |
| `[email protected]` | `myShopProject1#` |
| `[email protected]` | `myShopProject1#` |
| `[email protected]` | `myShopProject1#` |
| `[email protected]` | `myShopProject1#` |
| `[email protected]` | `myShopProject1#` |
| `[email protected]` | `myShopProject1#` |

## License
Distributed under the **MIT License**. See **[LICENSE](./LICENSE)** for more information.