Giter Site home page Giter Site logo

houcemnaffati / a-software-craftsmanship-kata Goto Github PK

View Code? Open in Web Editor NEW
11.0 1.0 4.0 1.39 MB

An advanced KATA to introduce Clean Code, TDD and Hexagonal Architecture.

Home Page: https://houcemnaffati.github.io/A-Software-Craftsmanship-KATA/

License: MIT License

HTML 20.28% TypeScript 62.70% JavaScript 9.46% SCSS 7.56%
typescript kata clean-architecture hexagonal-architecture tdd tdd-kata tdd-typescript tdd-react hexagonal-architectures clean-code

a-software-craftsmanship-kata's Introduction

TimedMessageGenerator:
A software craftsmanship KATA

I. Why do I need to train myself on this ?

Phil Crosby said :

It is always cheaper to do the job right the first time. If we deliver on time, but the product has defects, we have not delivered on time.

A software means an easy-to-change product. It needs to be easy to change and to adapt at any moment. If you find that after each requirement's change, your team are redoing the same application over and over again, :trollface: then you definitely need TDD and design skills. ๐Ÿ’Š ๐Ÿ’Ž

II. Is this suitable for my coding level ?

Well, you will need to have a strong OOP background and a good understanding of hexagonal architecture principles. โš ๏ธ

You can find my guidelines here. ๐Ÿ“–

III. Let's rock'n'roll!

This is an advanced exercise to introduce TDD, SOLID design principles and Hexagonal Architecture. ๐Ÿ’ป

  1. Implement example-mapped specifications using TDD. (~45min is a reasonable estimation) ๐Ÿ”จ
  2. Try to apply craftsmanship's rules and principles. ๐Ÿ”ง
  3. Experience the impact of the following changes on your code "in the given order" to measure your level of success. ๐Ÿ‘ป

IV. How to measure success ? ๐ŸŽฏ

  • Clean code should be easy to read by a non-programmer person.:surfer:

  • Clean design should be able to quickly adapt without impacting your tests.:ok_hand:

  • Your solution is tested easily.:dash:

  • The cost of changing UI library or framework is significantly cheap.:relaxed:

  • You felt happy that you had received a change or a new requirement.:sparkles:

  • You are confident that your solution is out of bugs at any time.:sunny:

  • Your application is always ready to be shipped.:rocket:

Happy coding FOLKS !

Check out my React.js|Typescript implementation here.

Please feel free to submit issues for improvements or create branches with examples of your solutions.:+1: Sharing is caring!

a-software-craftsmanship-kata's People

Contributors

houcemnaffati avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  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.