Skip to content

Commit c08aadc

Browse files
authored
Update README.md
1 parent 68ef0e9 commit c08aadc

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,33 @@
11
# Cucumber & Typescript Examample
2-
## Compute Wallet Value - Behavior Driven Developement
3-
Maxime d'Harboullé 4AL1
2+
3+
![example workflow](https://github.com/anonymax25/cucumber-typescript-example/actions/workflows/<WORKFLOW_FILE>/badge.svg)
4+
5+
## Author
6+
[Maxime d'Harboullé](https://github.com/anonymax25)
7+
8+
## Behavior Driven Developement
49
*Behavior Driven Developement school project to use cucumber for testing.*
510

6-
Choosen language: Typescript
11+
The goal of this example is to write and test code compute the value of a wallet containing differnet currencies in a given currency
12+
13+
Choosen language: <img src="https://slackmojis.com/emojis/1383-typescript/download" align="center" alt="typescript" title="image Title" height="25"/>
714

8-
## Install dependencies
15+
## Steps
16+
### 1- Install dependencies
917
```npm install```
1018

11-
## Scripts
19+
### 2 - Scripts
1220
```npm run build``` builds the ts into js to ./build
1321

1422
```npm run test:unit``` launches unit tests
1523

1624
```npm run test:cucumber``` launches cucumber tests on the features in ```./features/...```
25+
1726
## Prototype:
1827
```ts
1928
async function computeWalletValue(wallet: Wallet, returnValueCurrency: Currencies = Currencies.EUR, date: string = 'latest'): Promise<number>
2029
```
2130
**Possible currencies:** CAD HKD ISK PHP DKK HUF CZK AUD RON SEK IDR INR BRL RUB HRK JPY THB CHF SGD PLN BGN TRY CNY NOK NZD ZAR USD MXN ILS GBP KRW MYR
2231

23-
Check-out our unit test :```./test/test.js ``` for an example of how to call the function or run it by using ```npm run test:unit```
32+
Check-out our unit test: ```./test/test.js```, for an example of how to call the function or run it by using ```npm run test:unit```
2433

0 commit comments

Comments
 (0)