Skip to content

Commit b22e8ec

Browse files
authored
Update README.md
1 parent 75f91a6 commit b22e8ec

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1+
# Python Domain Driven Design (DDD) example project
2+
13
[![Build Status](https://travis-ci.org/Ermlab/python-ddd.svg?branch=master)](https://travis-ci.org/Ermlab/python-ddd)
24
[![codecov](https://codecov.io/gh/Ermlab/python-ddd/branch/master/graph/badge.svg)](https://codecov.io/gh/Ermlab/python-ddd)
35
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
46

5-
# Inroduction
7+
Disclaimer: this is a work in progress project, stay tuned for updates.
68

79
## The goal of this project
810

@@ -13,35 +15,35 @@ described here: https://www.ebay.co.uk/pages/help/buy/bidding-overview.html
1315

1416

1517

16-
# Domain
18+
## Domain
1719

1820
Online Auctions domain was selected for the purpose of this project, which is loosely based on Ebay bidding system.
1921

2022
The main reason for selecting this domain is general familiarity and limited complexity - many people understand how internet bidding work and the whole concept is not difficult to understand (or at least it's much simpler that healthcare or banking domains). On the other hand it's not simply a CRUD system - there are some business rules that must be implemented in the system.
2123

22-
## Domain description
24+
### Domain description
2325

2426
This is a summary of the information we got from a domain expert about how the auction system should work.
2527

26-
### Selling
28+
#### Selling
2729

2830
When you want to sell an item, the first step in getting your item in front of buyers is creating a `Listing`. For now we only focus on selling through auctions (https://www.ebay.com/help/selling/listings/auction-format?id=4110), but in the future we may consider selling with "Buy It Now" (https://www.ebay.com/help/selling/listings/selling-buy-now?id=4109) or in some other ways. When presenting an `Listing` for sale (which we call `publishing` in the Catalog), seller must provide a `Listing` duration and initial price. Also it is also possible to schedule a `Listing` publication (https://www.ebay.com/help/selling/listings/selecting-listing-duration?id=4652).
2931

3032
You can cancel your listing when bidding takes place, but only under certain circumstances: if time left in listing < 12 hrs you can cancel your listing only if no bids were places (but we might change it in the future).
3133

3234
If you are a new seller (you never sold an item before), you can list only one `Item` in the `Catalog` at a time.
3335

34-
### Buying
36+
#### Buying
3537

3638
When `Listing` is selled through auction `Bidding` takes place. As a `Buyer`, you can place a bid, which must be greated than the current price + 1 USD and which sets the the highest price you are willing to pay for an item. System will let you know if someone outbids you and you can decide if you want to increase your maximum limit. Sometimes you can can be automatically outbidded (if some other buyer sets his maximum limit higher that yours) - see https://www.ebay.com/help/buying/bidding/automatic-bidding?id=4014.
3739

3840
After a fixed time since the bidding was started a bidding ends and the `Winner` is announced.
3941

40-
### Payments
42+
#### Payments
4143

4244
At this point, payments are out of scope for this project.
4345

44-
### Users
46+
#### Users
4547

4648
Each user can be a `Seller` or a `Buyer` (or both). User priveledges can be elevated to a `Staff member` or `Administrator`.
4749

0 commit comments

Comments
 (0)