Skip to content

Commit e3660d7

Browse files
authored
Add a section discussing the use of an external database. (#8)
1 parent d3fbba2 commit e3660d7

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,18 @@ Design an API endpoint that provides auto-complete suggestions for large cities.
1919
- *You can use the language and technology of your choosing.* It's OK to try something new (tell us if you do), but feel free to use something you're comfortable with. We don't care if you use something we don't; the goal here is not to validate your knowledge of a particular technology.
2020
- End result should be deployed on a public Cloud (Heroku, AWS etc. all have free tiers you can use).
2121

22-
## Advices
22+
## Advice
2323

2424
- **Try to design and implement your solution as you would do for real production code**. Show us how you create clean, maintainable code that does awesome stuff. Build something that we'd be happy to contribute to. This is not a programming contest where dirty hacks win the game.
25-
- Feel free to add more features! Really, we're curious about what you can think of. We'd expect the same if you worked with us.
26-
- Documentation and maintainability is a plus.
27-
- Don't you forget those unit tests.
25+
- Documentation and maintainability are a plus, and don't you forget those unit tests.
2826
- We don’t want to know if you can do exactly as asked (or everybody would have the same result). We want to know what **you** bring to the table when working on a project, what is your secret sauce. More features? Best solution? Thinking outside the box?
2927

28+
## Can I use a database?
29+
30+
If you wish, it's OK to use external systems such as a database, an Elastic index, etc. in your solution. But this is certainly not required to complete the basic requirements of the challenge. Keep in mind that **our goal here is to see some code of yours**; if you only implement a thin API on top of a DB we won't have much to look at.
31+
32+
Our advice is that if you choose to use an external search system, you had better be doing something really truly awesome with it.
33+
3034
## Sample responses
3135

3236
These responses are meant to provide guidance. The exact values can vary based on the data source and scoring algorithm

0 commit comments

Comments
 (0)