@amxchange/grid-view-web-client
Version:
amxchange grid view framework web client in react ( a module extracted from existing jax )
75 lines (43 loc) • 1.93 kB
Markdown
# AMX GRID VIEW FRAMEWORK - WEB CLIENT
This is an npm package which is used for importing re-usbale React Frameworks (like FormFields, its various types,etc.) for common use by our Company Projects.
## PUBLISHING STEPS
### 1. Login to npm
Before publishing or pushing changes to npm, make sure you're logged in to your npm account. Use the following command to log in:
```bash
npm login
```
You will be prompted to enter your npm credentials:
```bash
Username
Password
Email
```
Once you are logged in, you can proceed with publishing updates or committing changes.
### 2. Commit Changes
After you've made changes to your project and throughly tested, especially to the build output (i.e dist/index.js), you should commit them.
To commit your changes:
```bash
git add .
git commit -m "{Framework_Name}:{change in the framework}"
git push origin main
```
for example,
Framework_Name: FormField: Updated a behaviour in select field
P.S : always commit the updated build, particularly the contents of the dist/index.js folder. Also, make sure the build is tested and changes are reflecting properly.
### 3. Updating Your Package Version
If you need to make updates to your package, modify your code and update the version number in package.json (following Semantic Versioning). For example:
(Assuming 1.0.0 is the active package version)
For a bug fix: 1.0.1 \
For a new feature: 1.1.0 \
For breaking changes: 2.0.0
### 4. Publish to npm
After committing your changes, if you want to publish the latest version of your package to npm, run:
```bash
npm publish
```
This will publish the current version of your package to the npm registry.
### 5. Verify Package Publication
To ensure your package has been published, you can visit the following npm page
```bash
https://www.npmjs.com/package/@amxchange/grid-view-web-client
```