Skip to content

Update README.md #426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,18 @@ python app.py

1. app.py: A flask application that exposes the following API endpoints:
- index at / : Retun a JSON data structure indicating the current balance.
- deposit at /deposit : Take the deposit amount as a URL parameter and return the new balance after adding the amount.
- withdraw at /withdraw : Take the withdrawal amount as a URL parameter and return the new balance after subtracting the amount.
- deposit at /deposit : Take the deposit amount as a URL parameter and return the new balance after adding the amount, e.g.
```
http://localhost:5000/deposit?amount=50
```
- withdraw at /withdraw : Take the withdrawal amount as a URL parameter and return the new balance after subtracting the amount, e.g.
```
http://localhost:5000/withdraw?amount=30
```
App relies on a global in-memory variable (`balance`) to store the balance of the account.

2. requirements.txt: A text file including all the Python libraries and packages needed to run the app.

3. .gitignore: Refer to the gitignore article for more details. In short, this file makes it possible that local configuration or binary files are not pushed to the repository.

4. tests: It's a directory that includes several unit tests for the APIs. The tests utilize the PyTest library.
4. tests: It's a directory that includes several unit tests for the APIs. The tests utilize the PyTest library.