Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pmareke authored Oct 30, 2024
1 parent 85853d6 commit e7ff2f7
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@
- The project has a `Dockerfile` ready to use to deploy the app in production.

## Requirements

- You only need to have [Poetry](https://python-poetry.org) installed.

## Folder structure

- There is a `tests` folder with the tests files.
- The `unit` folder contains the unit tests, also know as [F.I.R.S.T](https://dzone.com/articles/writing-your-first-unit-tests#:~:text=First%20class%20developers%20write%20their,self%2Dvalidating%2C%20and%20timely.&text=Unit%20tests%20are%20required%20to%20test%20singular%20sections%20of%20code.).
- The `unit` folder contains the unit tests, also known as [F.I.R.S.T](https://dzone.com/articles/writing-your-first-unit-tests#:~:text=First%20class%20developers%20write%20their,self%2Dvalidating%2C%20and%20timely.&text=Unit%20tests%20are%20required%20to%20test%20singular%20sections%20of%20code.).
- The `integration` folder contains the tests that will validate the connection between our app and the external services.
- The `acceptance` folder contains the tests that validate the app behavior from the outside.
- The production code goes inside the `src` folder.
Expand Down

0 comments on commit e7ff2f7

Please sign in to comment.