Skip to content

Commit

Permalink
fix: typo in server description
Browse files Browse the repository at this point in the history
  • Loading branch information
daniel-orlov committed Jul 25, 2023
1 parent 7e2c5e4 commit 2984d11
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![Go Report Card](https://goreportcard.com/badge/github.com/daniel-orlov/quotes-server)](https://goreportcard.com/report/github.com/daniel-orlov/quotes-server)
![Go Pipeline](https://github.com/daniel-orlov/quotes-server/actions/workflows/go.yaml/badge.svg)

Quotes server is the backend part of the test assignment solution for DDOS-protected TCP server.
Quotes server is the backend part of the test assignment solution for DDOS-protected HTTP server.

For more details on the technical requirements, see [docs/000_Requirements.md](docs/000_Requirements.md).

Expand Down
4 changes: 2 additions & 2 deletions docs/000_Requirements.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Requirements

## Design and implement “Word of Wisdom” tcp server.
## Design and implement “Word of Wisdom” http server.

- [x] TCP server should be protected from DDOS attacks with the Prof of
- [x] HTTP server should be protected from DDOS attacks with the Prof of
Work (https://en.wikipedia.org/wiki/Proof_of_work), the challenge-response protocol should be used.

- [x] The choice of the POW algorithm should be explained.
Expand Down
2 changes: 1 addition & 1 deletion docs/002_Project_architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This layered leverages the fact that each layer has its own responsibility
and could be changed without affecting other layers.
Layers are kept agnostic to each other by using interfaces.
That allows to easily change implementation of some layer without affecting other layers, for example,
If I wanted to introduce gRPC server instead of TCP server, I could easily do it by changing only transport layer.
If I wanted to introduce gRPC server instead of HTTP server, I could easily do it by changing only transport layer.
Similarly, if I wanted to change storage from in-memory to Redis, I could do it by changing only storage layer.
This solid foundation provides a lot of extensibility and flexibility for the project.
This also provided decent testability for the project, because I could easily mock any layer and test it in isolation.
Expand Down

0 comments on commit 2984d11

Please sign in to comment.