Cats is a command line interface to help you to drive your backend server side architecture. The goal is to fit the clean architecture's ideas.
This project aims to be a simple CLI allowing user to create, handle and modify easily their back-end projects in clean architecture by guiding them through all the steps. Cats is not meant to block you in a specific implementation, but to guide you in order to have a simple, yet powerful architecture.
If you encounter an bug, wish to contribute, or simply have a question, feel free to check the contributing guidelines and our code of conduct to help you through it!
As you may know, clean architecture is a principle, and can be interpreted in many ways. We do not claim to have the real and final architecture for this in typescript, this is simply our understanding of it.
Feel free to contribute!
- Install NodeJS, NPM should come with. Please use at least one of both LTS.
- Install Yarn 2, it is the as NPM but faster and stronger :
npm install -g yarn@berry
- Install Typescript
yarn global add typescript
yarn global add cats-cli
OR
npm install -g cats-cli
| Commands | Desciption | Options |
|---|---|---|
cats initialize |
Create in the current directory a brand new project | None |
You can find a lot of documentation for clean architecture, in a lot of languages. For our part, we believe that these resources are the best to start with:
- Uncle Bob's blog
- Uncle Bob's book
- Martin Fowler's Patterns of Enterprise Application Architecture
- explicit architecture
This project is under the GNU GENERAL PUBLIC LICENSE V3, feel free to check it before using this package.