Skip to content

Latest commit

 

History

History
116 lines (90 loc) · 3.83 KB

README.md

File metadata and controls

116 lines (90 loc) · 3.83 KB
Raw

ITA Project

Description should be here.

Project structure

  • App-Folder
    • /src - project source code folder
      • /assets - for assets ('.svg', '.ico'...)
      • /components - for shared basic components
      • /constants - for general constants
      • /containers - for complex components
      • /pages - for project pages
      • /plugins - for plugins
      • /styles - for general styles and style variables
    • /test - project tests folder
      • /coverage - coverage store
      • /unit - unit tests, should duplicate project structure

Components

Folder for basic shared project components. Like inputs, forms, buttons, table grids, loaders etc. Components should be stateless.

Containers

Folder for more complex project components. Example: Container for rendering list of items, with sorting filtering etc. Containers should also be stateless.

Pages

Folder for project pages. The page should manage it state, work with requests for BE, and pass props to containers and components.

Code conventions

Before any pull request, you have to make sure you tested your component and components your work could affect. Test your component with Unit tests. SELF-TESTING and good quality of unit tests may guaranty the success of the application.

Code style

The project has installed and configured ES Lint and Prettier. All rules are set, you can learn them in .eslintrc.json file.

Coding rules

  • Components and containers should not be deep nested. If so separate them into a couple of components.
  • JSX should not include complex logic (If else statements, handlers functions, etc.).
  • If a component or page has complex long logic statements, it should be separated or moved to a custom hook.
  • If the logic in components has been repeated it should be moved to custom hooks.
  • Components should be covered with unit tests. Coverage limit set for 80%. Pre push hooks are configured.
  • General CSS styles should be placed in the styles folder. Values that are repeated should be moved to CSS variables.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.