@ddict/popup 1.0.5 → 1.0.7

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 CHANGED
@@ -1 +1,53 @@
1
1
  # Ddict Popup
2
+
3
+ To get the Ddict Popup project up and running on your local machine, follow these steps:
4
+
5
+ ## Prerequisites
6
+ - Node v20+
7
+
8
+ ### Installation
9
+
10
+ ```
11
+ npm install
12
+ ```
13
+
14
+ ### Running the Project Locally
15
+
16
+ ```
17
+ npm run dev
18
+ ```
19
+ This command will start a local development server. You can now access the application in your web browser at the address provided in the terminal output (usually http://localhost:5173).
20
+
21
+ ### Run Lint Check
22
+
23
+ To check for linting errors, run:
24
+
25
+ ```
26
+ npm run lint
27
+ ```
28
+
29
+ This command will use ESLint to check your code for any linting errors based on the project's configuration.
30
+
31
+ ### Format Code with Prettier
32
+
33
+ To format your code according to the project's Prettier configuration, run:
34
+
35
+ ```
36
+ npm run format
37
+ ```
38
+
39
+ ### Building the Project
40
+
41
+ ```
42
+ npm run build
43
+ ```
44
+ This command compiles the application into static files in the dist directory. These files can then be deployed to a web server.
45
+
46
+ ## Previewing the Build
47
+
48
+ After building the project, you can preview the production build locally by running:
49
+
50
+ ```
51
+ npm run preview
52
+ ```
53
+ Check the terminal output for the local URL to access the preview (usually http://localhost:4173)