Git Product home page Git Product logo

has-to-be's Introduction

Challenge 2 (suggestions) :

1- Using nouns instead of verbs in the endpoints paths. (/rate could be /ratings) 2- Wrapping all the data in one place and adding message and using standard HTTP codes in the response 3- Caching (could be implemented on this api based on inputs by caching the output for the same inputs) 4- Versioning ( /v1 or /v2 etc) 5- Apply Rate Limit in case of unwanted attacks 6- Using api documentation tools like Swagger


How to run the application

1- Run git clone from the github repository. 2- Run "docker-compose build app" to build the application. 3- Run docker-compose up -d to make the containers up and running.


How to run testsuite

For running unit tests, inside of the php container run : 1- ./vendor/bin/phpunit path/to/test/file


Things that could be included but did not due to avoid over engineering

1- Design patterns

2- Implementing migrations for saving the total price (that could be used for caching as well)

3- Log system for any possible future data analysis


Things to consider

1- For following git flow, each step has been committed separately 2- There are two branches : master and feature/rating_process

has-to-be's People

Contributors

alireza1992 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.