https://github.com/anarbyrm/simpleatmapiservice

Simple ATM API service
https://github.com/anarbyrm/simpleatmapiservice

django django-rest-framework docker python3 sqlite

Last synced: 5 days ago
JSON representation

Simple ATM API service

• Host: GitHub
• URL: https://github.com/anarbyrm/simpleatmapiservice
• Owner: anarbyrm
• Created: 2024-08-10T09:14:06.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2024-08-10T16:40:35.000Z (3 months ago)
• Last Synced: 2024-08-11T10:38:37.791Z (3 months ago)
• Topics: django, django-rest-framework, docker, python3, sqlite
• Language: Python
• Homepage:
• Size: 25.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# SimpleATMApiService

## Introduction

Developed with leveraging Python, Django Rest Framework and sqlite technologies.

### Aim of the project

Simple ATM API service to withdraw specified amount of cash with as small as possible numbers of paper money.

Let's say ATM has 200, 100, 50, 20, 10, 5, and 1 units for azn currency and 70AZN needed to be withdrawn, so ATM service will produce

(50, 20) which is 2 paper money that is the minimum amount of paper.

## Steps to run the project with docker

1) Clone the project

```bash

git clone 

```

2) Build the project on the top of docker 

```bash

docker-compose up --build

```

3) Update database tables

```bash

docker-compose exec web python manage.py migrate

```

4) Go to the link: http://localhost:8000

5) For swagger ui go to the link: http://localhost:8000/swagger

## Steps to run project without docker

1) Clone the project

```bash

git clone 

```

2) Create virtual environment

```bash

python -m venv .venv

```

3) Install project libraries

```bash

python -m pip install -r requirements.txt

```

4) enter into src folder and run the server

```bash

python manage.py runserver

```

5) Finally you can checkout the endpoints on link:  http://localhost:8000