@kanvas/phoenix-cli

Phoenix CLI is a command line tool create the bootstraped all the minimum dependencies needed on a React project basically a web skeleton project inside the Kanvas ecosystem that brings:

• Directory Structure base on Atomic Design and Domain Driven Design.
• Testing using Jest and Cypress (Future).
• Custom Packages base on the new current needs.

All this small points base on the need of bootstrapping the applications faster.

Creating a new project

To create a new project using @kanvas/phoenix-cli is by running the following command

  npx @kanvas/phoenix-cli@latest <project_name>

Then select the type of project (next, react-vite)

After running it the project will generate the following directory structure

Next.JS example

- public
- e2e
- test
- src
  - components
    - atoms
    - molecules
    - organisms
    - templates
  - models
    - api - api and data calls
    - interactions - interactions like hooks and services that are going to be used
    - state - located state properties
    - types - located all interfaces, enums and states
  - locales
    - en.ts
    - es.ts
    - index.tsx
  - pages
    - api
    - exmaple
      - index.tsx
    - _app.tsx
    - index.tsx
- cypress.json
- jest.config.js
- tailwind.config.js
- postcss.config.js
- package.json
- yarn.lock

React-Vite example

- public
- e2e
- test
- src
  - components
    - atoms
    - molecules
    - organisms
    - templates
  - models
    - api - api and data calls
    - interactions - interactions like hooks and services that are going to be used
    - state - located state properties
    - types - located all interfaces, enums and states
  - pages
    - exmaple
      - about.tsx
      - welcome.tsx 
      - index.tsx
    - index.tsx
- index.html
- vite.config.ts
- tailwind.config.js
- postcss.config.js
- cypress.json
- jest.config.js
- package.json
- yarn.lock

References

• Structures
  • Domain-driven Design
  • Atomic Desing
• Tools
  • NextJS
  • Vite
  • Tailwindcss
  • Formik
  • @react/router
  • Jest
  • React Testing Library