@soyfri/template 1.0.3 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +58 -22
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,39 +1,75 @@
1
- # Metronic Template NPM Package
1
+ # @soyfri/template
2
2
 
3
- This NPM package provides essential utilities for integrating the Metronic theme into React projects. It includes helper functions, utility variables, and classes that facilitate the development of consistent and responsive user interfaces.
4
-
5
- ## Features
6
-
7
- - **Theme Layout Helpers**: Functions to streamline the implementation of Metronic's layout components.
8
- - **Utility Variables**: Predefined variables for consistent theming and styling across your application.
9
- - **CSS Utility Classes**: A collection of classes to apply common styles effortlessly.
3
+ ## Description
4
+ This package contains a Metronic template specifically designed for FRI frontend projects. It provides a set of pre-built components, styles, and utilities to streamline frontend development.
10
5
 
11
6
  ## Installation
12
-
13
- To install the package, run:
14
-
15
7
  ```bash
16
- npm install metronic-template
8
+ npm install @soyfri/template
9
+ # or
10
+ yarn add @soyfri/template
17
11
  ```
18
12
 
13
+ ## Requirements
14
+ ### Peer Dependencies
15
+ - React >=16.8.0
16
+ - React DOM >=16.8.0
17
+
19
18
  ## Usage
20
19
 
21
- Import the necessary utilities into your React project:
20
+ ### Basic Layout
21
+ Create a basic application layout using the package's wrapper components:
22
+
23
+ ```tsx
24
+ import { HeaderWrapper, FooterWrapper, Content } from '@soyfri/template';
25
+
26
+ function App() {
27
+ return (
28
+ <>
29
+ <HeaderWrapper />
30
+ <Content>
31
+ {/* Your content here */}
32
+ </Content>
33
+ <FooterWrapper />
34
+ </>
35
+ );
36
+ }
37
+ ```
38
+
39
+ ### Styling
40
+ To import the main SCSS stylesheet, add the following import to your main stylesheet or entry file:
22
41
 
23
- ```javascript
24
- import { layoutHelper } from 'metronic-template';
25
- // Use layoutHelper in your component
42
+ ```scss
43
+ @import '@soyfri/template/_metronic/assets/sass/style.react.scss';
26
44
  ```
27
45
 
28
- ## Dependencies
46
+ ### Internationalization
47
+ The package includes i18n support. To use it:
48
+
49
+ ```tsx
50
+ import { MetronicI18nProvider, setLanguage } from '@soyfri/template';
29
51
 
30
- This package serves as a core dependency for multiple React projects, ensuring a unified integration of the Metronic theme.
52
+ function App() {
53
+ return (
54
+ <MetronicI18nProvider>
55
+ {/* Your app content */}
56
+ </MetronicI18nProvider>
57
+ );
58
+ }
59
+ ```
31
60
 
32
- ## Repository
61
+ ## Features
62
+ - Pre-built React components
63
+ - Responsive design
64
+ - SCSS styling
65
+ - Internationalization support
66
+ - Easy integration with FRI frontend projects
33
67
 
34
- For more information, documentation, and contributions, visit the GitHub repository: [Metronic Template](https://github.com/soyfrii/Metronic-template)
68
+ ## Contributing
69
+ Please read our contributing guidelines before submitting pull requests.
35
70
 
36
71
  ## License
72
+ MIT
37
73
 
38
- This project is licensed under the MIT License.
39
-
74
+ ## Support
75
+ For support, please contact the FRI frontend development team.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@soyfri/template",
3
- "version": "1.0.3",
3
+ "version": "1.0.4",
4
4
  "description": "Metronic template components and utilities for Fri projects",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",