Full Stack Application

https://github.com/yaseen-kc/floreat
Admin
This project is a full-stack application providing a minimal setup for a React frontend with Vite...
Tokens:1,825
Snippets:19
Trust Score:6.6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Enable Type-Aware ESLint Rules

Source: https://github.com/yaseen-kc/floreat/blob/main/frontend/README.md

Configure ESLint to use type-aware lint rules by extending recommendedTypeChecked, strictTypeChecked, or stylisticTypeChecked configurations. Ensure project configurations are correctly specified.

```javascript
export default defineConfig([
  globalIgnores(['dist']),
  {
    files: ['**/*.{ts,tsx}']
    extends: [
      // Other configs...

      // Remove tseslint.configs.recommended and replace with this
      tseslint.configs.recommendedTypeChecked,
      // Alternatively, use this for stricter rules
      tseslint.configs.strictTypeChecked,
      // Optionally, add this for stylistic rules
      tseslint.configs.stylisticTypeChecked,

      // Other configs...
    ],
    languageOptions: {
      parserOptions: {
        project: ['./tsconfig.node.json', './tsconfig.app.json'],
        tsconfigRootDir: import.meta.dirname,
      },
      // other options...
    },
  },
])
```

--------------------------------

### Polycarbonate in Roof Configuration

Source: https://github.com/yaseen-kc/floreat/blob/main/backend/docs/Reference/Roof.md

Defines the dimensions and count for polycarbonate elements used in the roof.

```json
{
  "polycarbonateRoofLength": 0,
  "polycarbonateRoofWidth": 0,
  "polycarbonateRoofCount": 0
}
```

--------------------------------

### Side Extension Configuration

Source: https://github.com/yaseen-kc/floreat/blob/main/backend/docs/Reference/Roof.md

Defines parameters for roof, cladding, and side column extensions, including width/height and frame counts.

```json
{
  "roofExtensionWidthHeight": 0,
  "roofExtensionMidFrameCount": 0,
  "roofExtensionEndFrameCount": 0,

  "claddingExtensionWidthHeight": 0,
  "claddingExtensionMidFrameCount": 0,
  "claddingExtensionEndFrameCount": 0,

  "sideColumnsWidthHeight": 0,
  "sideColumnsMidFrameCount": 0,
  "sideColumnsEndFrameCount": 0
}
```

--------------------------------

### Covering Materials Configuration

Source: https://github.com/yaseen-kc/floreat/blob/main/backend/docs/Reference/Roof.md

Defines the type and thickness for roof and cladding covering materials, and roof area deductions.

```json
{
  "roofCoveringType": "PPGL",
  "roofCoveringThickness": 30,
  
  "claddingCoveringType": "PPGL",
  "claddingCoveringThickness": 0.4,
  
  "roofAreaDeduction": 0
}
```

--------------------------------

### Purlins Configuration

Source: https://github.com/yaseen-kc/floreat/blob/main/backend/docs/Reference/Roof.md

Defines the type, depth, and weight of roof and cladding purlins.

```json
{
  "roofPurlinType": "Z/C",
  "roofPurlinDepth": 150,
  "roofPurlinUnitWeight": 4.72,
  "claddingPurlinType": "Z/C",
  "claddingPurlinDepth": 150,
  "claddingPurlinUnitWeight": 4.72
}
```

--------------------------------

### Wind Bracings Configuration

Source: https://github.com/yaseen-kc/floreat/blob/main/backend/docs/Reference/Roof.md

Specifies parameters for wind bracings in both roof and column structures, including segments, bays, lengths, and type.

```json
{
  "roofWindBracingSegmentsInOneHalf": 1,
  "columnWindBracingSegments": 1,
  "roofWindBracingProvidedBays": 2,
  "columnWindBracingProvidedBays": 2,
  "windBracingColumnHeight": 5.6,
  "windBracingUnitWeight": 2.46,
  "roofWindBracingBaySpacing": 6,
  "columnWindBracingBaySpacing": 6,
  "roofWindBracingLength": 9.63698024,
  "columnWindBracingLength": 8.207313811,
  "windBracingType": "ROD"
}
```

--------------------------------

### Sidewall Configuration

Source: https://github.com/yaseen-kc/floreat/blob/main/backend/docs/Reference/Roof.md

Specifies the type, thickness, and height for all four sidewalls.

```json
{
  "frontSideWallType": "BRICK",
  "frontSideWallThickness": 200,
  "frontSideWallHeight": 2.4,
  
  "backSideWallType": "BRICK",
  "backSideWallThickness": 200,
  "backSideWallHeight": 2.4,
  
  "rightSideWallType": "BRICK",
  "rightSideWallThickness": 200,
  "rightSideWallHeight": 2.4,
  
  "leftSideWallType": "BRICK",
  "leftSideWallThickness": 200,
  "leftSideWallHeight": 2.4
}
```

--------------------------------

### Base Fixing Configuration

Source: https://github.com/yaseen-kc/floreat/blob/main/backend/docs/Reference/Roof.md

Specifies the type of base fixing used for the roof frames.

```json
{
  "roofFrameBaseFixing": "FOUNDATION_BOLT"
}
```

--------------------------------

### Fascia Board Configuration

Source: https://github.com/yaseen-kc/floreat/blob/main/backend/docs/Reference/Roof.md

Specifies the total area and material weight per square foot for fascia boards.

```json
{
  "fasciaBoardArea": 51.72,
  "fasciaMaterialWeightPerSqft": 1
}
```

--------------------------------

### Flange Brace Configuration

Source: https://github.com/yaseen-kc/floreat/blob/main/backend/docs/Reference/Roof.md

Specifies the average lengths for flange braces in the roof, cladding, and end frames.

```json
{
  "roofFlangeBraceAverageLength": 1.5,
  "claddingFlangeBraceAverageLength": 1,
  "endFrameFlangeBraceAverageLength": 0.5
}
```

--------------------------------

### PEB Roof Configuration

Source: https://github.com/yaseen-kc/floreat/blob/main/backend/docs/Reference/Roof.md

Defines the overall dimensions and structural parameters for a Pre-Engineered Building (PEB) roof.

```json
{
  "buildingOverallLength": 30,
  "buildingOverallWidth": 15,
  "eaveHeight": 5.645,
  "roofSlope": 6,
  "mainRoofFrames": 4,
  "endRoofFrames": 2,
  "roofPurlinSpacing": 1.27,
  "claddingPurlins": 2,
  "internalColumnsForMainRoofFrames": 2,
  "internalColumnsForEndRoofFrames": 2
}
```

--------------------------------

### Cladding Openings Configuration

Source: https://github.com/yaseen-kc/floreat/blob/main/backend/docs/Reference/Roof.md

Defines the area of openings in the cladding for each of the four sides.

```json
{
  "frontCladdingOpeningArea": 45,
  "backCladdingOpeningArea": 0,
  "rightCladdingOpeningArea": 0,
  "leftCladdingOpeningArea": 0
}
```

--------------------------------

### Material Strength/Grade Configuration

Source: https://github.com/yaseen-kc/floreat/blob/main/backend/docs/Reference/Roof.md

Defines the material grade for plates, with allowed enum values.

```json
{
  "plateMaterialGrade": "enum"
}
```

--------------------------------

### Add React-Specific ESLint Rules

Source: https://github.com/yaseen-kc/floreat/blob/main/frontend/README.md

Integrate eslint-plugin-react-x and eslint-plugin-react-dom to enable lint rules specifically for React and React DOM development. This enhances code quality and consistency for React applications.

```javascript
// eslint.config.js
import reactX from 'eslint-plugin-react-x'
import reactDom from 'eslint-plugin-react-dom'

export default defineConfig([
  globalIgnores(['dist']),
  {
    files: ['**/*.{ts,tsx}']
    extends: [
      // Other configs...
      // Enable lint rules for React
      reactX.configs['recommended-typescript'],
      // Enable lint rules for React DOM
      reactDom.configs.recommended,
    ],
    languageOptions: {
      parserOptions: {
        project: ['./tsconfig.node.json', './tsconfig.app.json'],
        tsconfigRootDir: import.meta.dirname,
      },
      // other options...
    },
  },
])
```

--------------------------------

### Roof Members Configuration

Source: https://github.com/yaseen-kc/floreat/blob/main/backend/docs/Reference/Roof.md

Specifies the number and type of structural members within the main and end roof frames.

```json
{
  "columnSegmentsInMainFrame": 1,
  "raftersInOneHalfOfMainFrame": 2,
  "columnSegmentsInEndFrame": 1,
  "raftersInOneHalfOfEndFrame": 2,
  "endFrameHorizontalTieBeam": 0
}
```
Tokens:
Raw