joaowillamy/realiza

A full cycle project in nodejs using nestjs for backend and nextjs for frontend, the monorepo is manage by NX

Realiza

Global Requere

• node
• yarn
• nx

Technologies

• Nestjs (backend)
  • Mailer
  • Logger Winston
  • Doc generetor by swagger
  • Https
  • TypeOrm for database
  • Authentication with Passport
• Nextjs (frontend)
  • React
  • Storybook
  • Styled component
  • React hook form
  • React query
• Infrastructure
  • NX - Monorepo
  • Docker componse
  • Typescript
  • Jest
  • Linters
• Cypress (e2e)
  • Test end to end

Initial settup:

yarn install
yarn create-certs
docker-compose up -d
yarn start:dev

Lint:

yarn lint:fix

// or

yarn nx run-many --target=lint --all --fix

// or more specific if you want

yarn nx lint api
yarn nx lint <project name>

Typescript check - tscheck

run

yarn tscheck

or

yarn nx run-many --target=tsc --all --only-failed 

configure

In a new module you have to add in projec.json this config

{
  "targets": {
    ...
    "tsc": {
      "executor": "@webpro/nx-tsc:tsc",
      "options": {
        "tsConfig": ["tsconfig.json"]
      }
    }
  }
}

Storybook

Running Storybook:

nx run project-name:storybook
nx storybook project-name
nx run project-name:build-storybook

Add a new story

nx generate @nrwl/react:component-story --componentPath=<path> --project=<projec-name> --verbose

Example:

nx generate @nrwl/react:component-story --componentPath=pages/auth/confirme-email/[token].tsx --project=consumer-frontend --verbose

Configure your Story project using TypeScript

nx generate @nrwl/react:storybook-configuration consumer-frontend --bundler=webpack --configureTestRunner --no-generateCypressSpecs --tsConfiguration

Test (Jest)

Running test:

yarn test
nx run project-name:test
nx test project-name

Grouping modules:

Backend modules

  nx g @nrwl/nest:lib module
  nx g move --project module <group>/module

Frontend modules

  nx g @nrwl/next:lib module
  nx g move --project module <group>/module