Skip to content

Commit

Permalink
Clarify the assignment output. (#3)
Browse files Browse the repository at this point in the history
* Clarify the assignment output.

The location of the documentation is not so clear in the current output description.
In this PR we make it clear that we expect a README file in the root of the API repo documenting the trade-offs and train of thoughts.
  • Loading branch information
zekus authored Oct 16, 2023
1 parent 675974c commit ed72b8a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ In doing so:

### Output

1. We expect to see the code for the following, available in one or multiple git repositories (ex. GitHub, GitLab, Bitbucket, ...):
1. We expect to see the code for the following, available in one or multiple Git repositories (ex. GitHub, GitLab, Bitbucket, ...):

- A library/component that packages the import service and the interface for accessing the geolocation data.
- A REST API application that uses the library above.

2. We also expect to see the application running. To do that, the code should be deployed on a Cloud Platform of your choice (e.g. [Gigalixir](https://www.gigalixir.com/), [Heroku](https://www.heroku.com/), [Fly.io](https://fly.io/), [Digital Ocean](https://www.digitalocean.com/), AWS, Google Cloud or Azure), and the sample data, should be imported into the deployed application (according to the cloud platform limits). Please use `cloud_data_dump.csv` as the file to import into the deployed application.
3. We would like to see your train of thought and trade-offs written down in a file.
3. We would like to see your train of thought and trade-offs written down. To do so, please include a README file in the root folder of the API repo.

#### Bonus

Expand Down

0 comments on commit ed72b8a

Please sign in to comment.