@vini-wine/admin-core-models 1.0.0-beta.0 → 1.0.1
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.
- package/README.md +57 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# @vini-wine/admin-core-models
|
|
2
|
+
|
|
3
|
+
This package provides core models related to the admin api for the Vini frontend, designed to support TypeScript. It includes all frontend models related to the admin api essential for the Vini frontend.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
To install the package in your project, you can use npm or yarn. In your project directory, run one of the following commands:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# Using npm
|
|
11
|
+
npm install @vini-wine/admin-core-models
|
|
12
|
+
```
|
|
13
|
+
```bash
|
|
14
|
+
# Using yarn
|
|
15
|
+
yarn add @vini-wine/admin-core-models
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Usage
|
|
19
|
+
### Importing Models in TypeScript
|
|
20
|
+
In your TypeScript files, you can import the models from the package as needed. Here's an example:
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import {
|
|
24
|
+
FirstModel,
|
|
25
|
+
SecondModel,
|
|
26
|
+
ThirdModel,
|
|
27
|
+
// ... other enums
|
|
28
|
+
} from "@vini-wine/admin-core-models";
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Usage in Your Application
|
|
32
|
+
Once you have imported the models into your project, you can use them as needed. Here's an example of how to use the models in your application:
|
|
33
|
+
|
|
34
|
+
```typescript
|
|
35
|
+
import {
|
|
36
|
+
FirstModel,
|
|
37
|
+
SecondModel,
|
|
38
|
+
ThirdModel,
|
|
39
|
+
// ... other enums
|
|
40
|
+
} from "@vini-wine/admin-core-models";
|
|
41
|
+
|
|
42
|
+
// Use the enums in your application logic
|
|
43
|
+
const obj: FirstModel = {
|
|
44
|
+
property1: '',
|
|
45
|
+
// ... other properties
|
|
46
|
+
};
|
|
47
|
+
|
|
48
|
+
// ... more examples based on your specific enums
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Scripts
|
|
52
|
+
The package includes the following npm scripts:
|
|
53
|
+
|
|
54
|
+
- build: Run tsup to build the project.
|
|
55
|
+
- test: Placeholder for running tests (not specified).
|
|
56
|
+
- lint: Run ESLint for linting with TypeScript support.
|
|
57
|
+
- format: Use Prettier to format code.
|