@dejwcake/craftable 0.0.3 → 0.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.
- package/README.md +35 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,10 +1,42 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Craftable frontend
|
|
2
2
|
This is a frontend dependency of [Craftable](https://github.com/BRACKETS-by-TRIAD/craftable). Craftable is a Laravel-based open-source toolkit for building administration interfaces.
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
This package is part of [Craftable](https://github.com/dejwCake/craftable) (`dejwCake/craftable`), an administration starter kit for Laravel 12, forked from [Craftable](https://github.com/BRACKETS-by-TRIAD/craftable) (`brackets/craftable`).
|
|
7
|
+
|
|
8
|
+
## Documentation
|
|
9
|
+
You can find the full documentation at https://www.getcraftable.com/
|
|
7
10
|
|
|
8
11
|
## Issues
|
|
9
12
|
Where do I report issues?
|
|
10
|
-
If something is not working as expected, please open an issue in the main repository https://github.com/
|
|
13
|
+
If something is not working as expected, please open an issue in the main repository https://github.com/dejwCake/craftable.
|
|
14
|
+
|
|
15
|
+
## Publishing to npm
|
|
16
|
+
|
|
17
|
+
Follow these steps to publish a new version of the package to npm:
|
|
18
|
+
|
|
19
|
+
1. **Prerequisites**
|
|
20
|
+
- Ensure you have an npm account and are added as a collaborator/owner of the package.
|
|
21
|
+
- Log in from your terminal: `npm login`.
|
|
22
|
+
|
|
23
|
+
2. **Check and bump the version**
|
|
24
|
+
- Inspect the current version in `package.json`.
|
|
25
|
+
- Bump it according to [semver](https://semver.org/) using one of:
|
|
26
|
+
- `npm version patch`
|
|
27
|
+
- `npm version minor`
|
|
28
|
+
- `npm version major`
|
|
29
|
+
|
|
30
|
+
3. **Build**
|
|
31
|
+
- Build the package:
|
|
32
|
+
- `npm run build`
|
|
33
|
+
|
|
34
|
+
4. **Dry-run the publish**
|
|
35
|
+
- Verify what would be published without actually publishing:
|
|
36
|
+
- `npm publish --dry-run`
|
|
37
|
+
|
|
38
|
+
5. **Publish the package**
|
|
39
|
+
- When everything looks correct, publish to npm:
|
|
40
|
+
- `npm publish`
|
|
41
|
+
- For scoped packages you want public:
|
|
42
|
+
- `npm publish --access public`
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dejwcake/craftable",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.4",
|
|
4
4
|
"description": "This is a frontend dependency for Craftable. Craftable is a Laravel-based open-source toolkit for building administration interfaces.",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"scripts": {
|