Skip to content

Commit 10cf7d3

Browse files
authored
Update README.md
1 parent 102a8a8 commit 10cf7d3

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@ The code is organized as follows:
5151
- `LICENSE`
5252

5353

54-
Disclaimer: The purpose and usage of this repo is solely for insight adquisition regarding problem-solving,
54+
Disclaimer: The purpose and usage of this repo is solely for insight acquisition regarding problem-solving,
5555
and does not represent an existing and ongoing implementation task.
5656

57-
PS: We provide this structure as an starting point but you may discard it and approach the task in
57+
PS: We provide this structure as a starting point but you may discard it and approach the task in
5858
any other way.
5959

6060
## The problem
@@ -75,11 +75,34 @@ The workflow that the system should support is:
7575
> _See the docs: [https://www.alphavantage.co/documentation/#crypto-exchange](https://www.alphavantage.co/documentation/#crypto-exchange)_
7676
7777
## Tasks
78+
### 1. Forex data retrieval
79+
#### What we want
80+
#### What we will evaluate
7881

7982

80-
## Evaluation
83+
### 2. API endpoint for retrieving the fetched forex data
84+
#### What we want
85+
#### What we will evaluate
8186

8287

88+
### 3. Interface to list followed
89+
#### What we want
90+
We provide you with three basic endpoints for subscribing, unsubscribing and listing the subscriptions
91+
to different currencies:
92+
93+
- [POST] /api/currency` Subscribe new currency
94+
- [PUT] /api/currency/:code` Unsubscribe currency
95+
- [GET] /api/currency` Get subscribed currency codes
96+
97+
We want a view that lists the subscribed currencies along with their forex data, and that allows to
98+
add or remove subscriptions. Here is a mockup of it could look, although you are free to design it
99+
however you feel it works best.
100+
101+
![image](https://user-images.githubusercontent.com/28607713/212859859-462fe5b8-e05f-4332-a5ee-098500a78418.png)
102+
103+
104+
#### What we will evaluate
105+
83106
## How to run the services
84107
We provide you with Makefile rules for you to lift individual services:
85108
- The _services/api_ directory holds the code for the API. The following make commands are available:

0 commit comments

Comments
 (0)