This repository is written to test candidate's skills when it comes to writing clean and maintainable code base. In the real world, we rarely get the chance to develop our code base from scratch and most often we have to deal with the code which is either legacy or not ours. In order to write this repository, we wrote a simple tax calculator which was used to calculate the taxes you had to pay on your income. Then we remove the parts we didn't need and wrote a simple shopping cart manager.
We expect the candidates to refactor the code to best their abilities to make the code cleaner, testable and maintainable. To what extend the candidates want to refactor the code base is up to them but the functionality of the application MUST REMAIN THE SAME. The candidate is allowed to change the code base however it's needed.
- Clone the repository
- Make small changes, commit
- Repeat
- The finished work should include all the git commits whether in a repository or zip file
First you need docker to build the dependencies. You can skip this part if you already have mysql on your system. All you need to do it changing MySQL credentials in pkg/db/get_db.go
cd docker
docker compose up -d --build
Once the containers are up and ready, you can run the application:
cd cmd
cd web-api
go run main.go
This will run the application and a simple web server will start listening on port 8088. By opening the http://localhost:8088/ in your browser you should be able to see the application.
The application has three simple routes:
- Show the form to add/remove products from cart
- Add products to your cart
- Remove carts from your cart
- Is the new code cleaner?
- Does it have tests? What kind of test?
- If we want to extend it, how easy or hard it is?
- Are there any security flaws? Any major performance issues?
- Does it work the same as before?