react-template-ts

{{project name}} web app

Project architecture:

• Framework: React

• Language: Typescript

• Web standard: HTML 5

• Styling framework: SASS

• Packet manager: Yarn

Project requirements:

Requirements for the project: {{here will go requirements}}

Shared design: {{here will go design for the project, if it exist}}

API swagger/documentation: {{documentation for the API, if it exist}}

Project implementation:

Application parts below are flagged like this:

• 📒 Folders
• 📑 Files

Project arhitecture:

• 📒 api
  • 📒 request-objects
  • 📒 requests
• 📒 app
  • 📒 login
    • 📒 components
      • 📑 login-container.tsx
      • 📑 login.tsx
    • 📒 actions
      • 📑 login-actions.ts
    • 📒 reducers
      • 📑 login-reducers.ts
    • 📒 constants
      • 📑 login-constants.ts
      • 📑 action-types.ts
    • 📒 validators
      • 📑 validators.ts
• 📒 common
  • 📒 images
  • 📒 styles
  • 📑 constants.ts
  • 📑 routes-constants.ts
  • 📑 helpers.ts
• 📒 components
  • 📒 button 📑 button.tsx 📑 button.scss
• 📒 core
  • 📑 axios-config.ts
  • 📑 root-reducer.ts
  • 📑 routes.ts
  • 📑 store.ts
• 📒 tests
• 📑 package.json
• 📑 README.md

Setting up project:

• Install dependencies: yarn install

• Start project: yarn start

• Create a deployable build yarn build

• Trigger tests yarn test

• Trigger cypress tests yarn test-integration

• Trigger cypress tests (silent mode) yarn test-integration-run

• Start generator for generating feature boilerplate yarn generate

• Start storybook yarn storybook

Testing: Cypress is configured for testing purposes. Also, react-testing-library is added in the list of the dev dependencies for unit testing.

Authors and contributors

• Eldin Soljic - Sholja - Software Developer

See also the list of contributors who participated in this project.

Happy coding!