chg: added a bit more dev context to the readme file !minor
All checks were successful
continuous-integration/drone/push Build is passing
All checks were successful
continuous-integration/drone/push Build is passing
This commit is contained in:
parent
66b8c1bc53
commit
d97b046cc6
2 changed files with 9 additions and 1 deletions
|
|
@ -14,6 +14,7 @@ cp bernini/settings.py-template bernini/settings.py
|
||||||
poetry install
|
poetry install
|
||||||
./wrapper mi # migrate
|
./wrapper mi # migrate
|
||||||
./wrapper r # runserver at localhost:8000
|
./wrapper r # runserver at localhost:8000
|
||||||
|
# goto localhost:8000/api
|
||||||
```
|
```
|
||||||
#### server email configuration
|
#### server email configuration
|
||||||
- open bernini/settings.py and fill these fields
|
- open bernini/settings.py and fill these fields
|
||||||
|
|
@ -35,8 +36,16 @@ EMAIL_USE_TLS = True
|
||||||
### api
|
### api
|
||||||
- based on [Django REST framework](https://www.django-rest-framework.org/)
|
- based on [Django REST framework](https://www.django-rest-framework.org/)
|
||||||
- auth system using and extending django's `contrib.auth`
|
- auth system using and extending django's `contrib.auth`
|
||||||
|
- admin available at [/](http://localhost:8000/)
|
||||||
|
- api available at [/api](http://localhost:8000/api)
|
||||||
- documentation available at
|
- documentation available at
|
||||||
- [/docs/openapi](http://localhost:8000/docs/openapi)
|
- [/docs/openapi](http://localhost:8000/docs/openapi)
|
||||||
- [/docs/swagger](http://localhost:8000/docs/swagger)
|
- [/docs/swagger](http://localhost:8000/docs/swagger)
|
||||||
- [/docs/redoc](http://localhost:8000/docs/redoc)
|
- [/docs/redoc](http://localhost:8000/docs/redoc)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### models
|
||||||
|
- `Product`: self-explanatory -- models a price and a name describing the product
|
||||||
|
- `SaleOrderLine`: middleman model between the main sale one and a product, needed in order to add quantities to the aforementioned main sale model
|
||||||
|
- `SaleOrder`: main sale model
|
||||||
|
|
@ -4,7 +4,6 @@ from rest_framework import status
|
||||||
from rest_framework.utils import json
|
from rest_framework.utils import json
|
||||||
|
|
||||||
from order.models import SaleOrder, SaleOrderLine, Product
|
from order.models import SaleOrder, SaleOrderLine, Product
|
||||||
from order.serializers import SaleOrderSerializer
|
|
||||||
|
|
||||||
|
|
||||||
class OrderTests(TestCase):
|
class OrderTests(TestCase):
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue