PROJECT NAME: iriswall v.1
##############################################################################
PROJECT STRUCTURE:
##############################################################################
─ iriswall
│ ├── __init__.py
│ ├── __pycache__
│ │ ├── __init__.cpython-310.pyc
│ │ ├── settings.cpython-310.pyc
│ │ ├── urls.cpython-310.pyc
│ │ └── wsgi.cpython-310.pyc
│ ├── asgi.py
│ ├── settings.py
│ ├── urls.py
│ └── wsgi.py
├── manage.py
├── requirements.txt
├── wall
│ ├── __init__.py
│ ├── __pycache__
│ │ ├── __init__.cpython-310.pyc
│ │ ├── admin.cpython-310.pyc
│ │ ├── apps.cpython-310.pyc
│ │ ├── models.cpython-310.pyc
│ │ ├── tests.cpython-310.pyc
│ │ └── views.cpython-310.pyc
│ ├── admin.py
│ ├── apps.py
│ ├── migrations
│ │ ├── __init__.py
│ │ └── __pycache__
│ │ └── __init__.cpython-310.pyc
│ ├── models.py
│ ├── tests.py
│ └── views.py
└── workers.log
##############################################################################
QUICKSTART:
UNIX:
-
From root directory run
python3 manage.py runserveroptional you can use for a specific port. -
By default the api can be accessed on localhost:8000
-
You can run all test from ROOT directory of the project:
python3 manage.py test wall.tests.WallTests
DOCKER:
-
You can also run the project with Docker
Dockerfileis available in the root dir of the project -
docker build -t <image_name> . now the project is available as a local img
-
docker run -it -p
: <image_name> e.g. docker run -it -p 8000:8000 iriswall
-
Now the API is available on 0.0.0.0:8000
-
You can log on the container like docker exec -it bash. And run the test
python3 /iriswall/mamange.py test wall.tests.WallTests
##############################################################################
OVERVIEW:
-
main implementation of the logis is /iriswall/wall/views.py
-
test - /iriswall/wall/tests.py
-
urls - /iriswall/wall/urls.py