Installing npm Package from GitHub¶
To install the @spreadsheetimporter/ui5-cc-spreadsheetimporter-pro
package directly from a GitHub repository, you'll need a personal access token from GitHub and configure npm to use it. Below are the steps:
1. Be a member of the GitHub organization ``¶
- After purchasing the Spreadsheet Importer package, you'll receive an invitation to join the GitHub organization.
- If you did not receive an invitation, please contact us at marian@marianzeis.de.
2. Generating a Personal Access Token on GitHub¶
- Navigate to GitHub and log in.
- Click on your profile picture (top right) and choose Settings.
- In the left sidebar, click on Developer settings.
- Choose Personal access tokens from the left sidebar.
- Click Generate new token.
- Provide a descriptive name for the token in the Note field.
- Under scopes, select the
repo
andread:packages
checkboxes to allow access to private repositories and packages. - Click Generate token.
- Copy the generated token. Note: This is your only chance to copy the token. If lost, you'll have to create a new one.
3. Configuring npm with .npmrc
¶
More Information: Configuring npm for use with GitHub Packages
You can either set up a project-specific .npmrc
file or edit the global ~/.npmrc
.
For Project-specific Configuration¶
- Go to your project directory.
- Create or open the
.npmrc
file.
@spreadsheetimporter:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=YOUR_PERSONAL_ACCESS_TOKEN
Replace YOUR_PERSONAL_ACCESS_TOKEN with the token you generated in step 2.
Now you can install the package:
For Global Configuration¶
- Open the
~/.npmrc
file. - Add the following line:
- Save the file.
Now you can install the package:
4. Using the Package¶
Now you can start using the package in your project.
For more information, please refer to the Getting Started Page.
The documentation for pro features is here: