Skip to content

Commit

Permalink
docs: update new README✨
Browse files Browse the repository at this point in the history
  • Loading branch information
hossainchisty committed Nov 3, 2021
1 parent 70c9283 commit 9bccdc5
Show file tree
Hide file tree
Showing 7 changed files with 106 additions and 2 deletions.
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,30 @@
### Multi vendor e-commerce marketplace platform with RBAC feature✨
<div align="center">

<h2>Welcome to the Multi vendor e-commerce platform</h2>

<a href="https://drawsql.app/backend-/diagrams/multivendor-ecommerce-software">![Lomofy SQL Diagram](https://img.shields.io/badge/Lomofy-Diagram%20-blue)</a>
<a href="https://open.vscode.dev/hossainchisty/"><img src="https://open.vscode.dev/badges/open-in-vscode.svg" height="25px"></a>


</div>

<br/>

## The Lomofy Diagram

--> *Preview :*

<div align="center">
<a href="https://drawsql.app/backend-/diagrams/multivendor-ecommerce-software">
<img width="80%" align="center" src="./img/drawSQL.png"/>
</a>
</div>

<br/>

--> *Full View:*

You can see clearly the diagram at :&nbsp; <a href="https://drawsql.app/backend-/diagrams/multivendor-ecommerce-software"><img align="center" src="https://img.shields.io/badge/Lomofy-SQL%20Diagram%20-orange"></a>
## Introduction

The application is multivendor eCommerce platform with Role-based access control (RBAC) that empowers multiple vendors to sell their products from one storefront. Multivendor store gives shoppers a huge catalog to choose from and provides sellers with a bigger base of ready-to-buy customers.
Expand All @@ -18,7 +43,7 @@ The application is multivendor eCommerce platform with Role-based access control
- [🌐 Deployment](docs/deployment.md)
- [📚 Additional Resources](docs/additional-resources.md)

### Get in touch
## Get in touch

<a class="header-badge" target="_blank" href="https://www.linkedin.com/in/hossainchisty/">
<img src="https://img.shields.io/badge/style--5eba00.svg?label=LinkedIn&logo=linkedin&style=social">
Expand Down
18 changes: 18 additions & 0 deletions docs/additional-resources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# 📚 Additional Resources

## Django

- [Official Documentation](https://docs.djangoproject.com/en/3.2/)

## Python

- [Official Documentation](https://docs.python.org/3.9/)

## Celery

- [Official Documentation](https://docs.celeryproject.org/en/stable/)

## Django Redis
- [Official Documentation](https://django-redis-cache.readthedocs.io/en/latest/)


6 changes: 6 additions & 0 deletions docs/deployment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# 🌐 Deployment

Deploy and serve your applications and assets over a CDN for best delivery and performance. Good options for that are:

- [Heroku](https://dashboard.heroku.com/)
- [Cloudinary](https://cloudinary.com/)
5 changes: 5 additions & 0 deletions docs/error-handling.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# ⚠️ Error Handling

### Error Tracking

You should track any errors that occur in production. Although it's possible to implement your own solution, it is a better idea to use tools like [Sentry](https://sentry.io/). It will report any issue that breaks the app. You will also be able to see on which platform, browser, etc. did it occur. Make sure to upload source maps to sentry to see where in your source code did the error happen.
35 changes: 35 additions & 0 deletions docs/security.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# 🔐 Security Policy

## Supported Versions

Use this section to tell people about which versions of your project are
currently being supported with security updates.

| Version | Supported |
| ------- | ------------------ |
| 5.1.x | :white_check_mark: |
| 5.0.x | :x: |
| 4.0.x | :white_check_mark: |
| < 4.0 | :x: |

## Reporting a Vulnerability

Use this section to tell people how to report a vulnerability.

Tell them where to go, how often they can expect to get an update on a
reported vulnerability, what to expect if the vulnerability is accepted or
declined, etc.

### Authorization

Authorization is a process of determining if the user is allowed to access a resource.

#### RBAC (Role based access control)

The most common method. Define allowed roles for a resource and then check if a user has the allowed role in order to access a resource. Good example is `USER` and `ADMIN` roles. You want to restrict some things for users and let admins access it.

#### PBAC (Permission based access control)

Sometimes RBAC is not enough. Some of the operations should be allowed only by the owner of the resource. For example user's comment - only the author of the comment should be able to delete it. That's why you might want to use PBAC, as it is more flexible.

For RBAC protection you can use the `RBAC` component by passing allowed roles to it. On the other hand if you need more strict protection, you can pass policies check to it.
15 changes: 15 additions & 0 deletions docs/style-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# 👁️ Style Guide

When you work with large projects, it's important that you remain consistent throughout the codebase and follow the best practices. To guarantee the quality of your codebase, you need to analyze different levels of the applications code.

## Clean Code

This is the most abstract level of code standardization. It's related to the implementations independent of the programming language. It will help the readability of your code.

[Clean Code Python](https://github.com/zedr/clean-code-python)

### Naming

One of the most important points of the Clean Code is how you name your functions, variables, components, etc. Use this amazing guide to understand how to write better variable names.

[Naming Cheatsheet](https://realpython.com/python-pep8/)
Binary file added img/drawSQL.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9bccdc5

Please sign in to comment.