From d97b046cc6868c5dbb076b7b3822722394229363 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?c=C4=83t=C4=83lin?= Date: Mon, 25 Jan 2021 15:11:10 +0100 Subject: [PATCH] chg: added a bit more dev context to the readme file !minor --- README.md | 9 +++++++++ order/tests.py | 1 - 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4f3e49e..4278ee3 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ cp bernini/settings.py-template bernini/settings.py poetry install ./wrapper mi # migrate ./wrapper r # runserver at localhost:8000 +# goto localhost:8000/api ``` #### server email configuration - open bernini/settings.py and fill these fields @@ -35,8 +36,16 @@ EMAIL_USE_TLS = True ### api - based on [Django REST framework](https://www.django-rest-framework.org/) - 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 - [/docs/openapi](http://localhost:8000/docs/openapi) - [/docs/swagger](http://localhost:8000/docs/swagger) - [/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 \ No newline at end of file diff --git a/order/tests.py b/order/tests.py index b160642..fb2f9a1 100644 --- a/order/tests.py +++ b/order/tests.py @@ -4,7 +4,6 @@ from rest_framework import status from rest_framework.utils import json from order.models import SaleOrder, SaleOrderLine, Product -from order.serializers import SaleOrderSerializer class OrderTests(TestCase):