Commit cf937deb authored by Mark Ghiorso's avatar Mark Ghiorso

Updates for installation at npmjs.org

parent 5c9dadfc
......@@ -27,10 +27,14 @@ be added in a subsequent release.
### 1. Installing the labextension
To install the labextension, enter the following in your terminal:
To install the labextension locally, enter the following in your terminal:
```bash
jupyter labextension install .
```
To install the extension from the npm repository, enter the following in your tewrminal:
```
[sudo] jupyter labextension install @enki-portal/gitlab
```
### 2. Getting your private key credentials from GitLab
......@@ -51,16 +55,34 @@ After you click on the extension tab (left side of the JupyterLab browser window
## Development
For a development install (requires npm version 4 or later), do the following in the repository directory:
For a development install (requires npm version 4 or later), open a terminal window and execute the following in the repository directory:
```bash
npm install
jupyter labextension link .
npm run build
jupyter labextension install . --no-build
```
Open an additional window and launch JupyterLab in "watch" mode:
```
jupyter lab --watch
```
To rebuild the package and the JupyterLab app:
## Publish the package to npmjs.org
```bash
npm run build
jupyter lab build
*npm* is both a JavaScript package manager and the de facto registry for JavaScript software. You can sign up for an account on the *npmjs.com* site or create an account from the command line by running
```
npm adduser
```
and entering values when prompted.
Next, open the project ```package.json``` file in your text editor. Prefix the name field value with ```@your-npm-username>/`` so that the entire field reads ```"name": "@your-npm-username/gitlab"``` where you’ve replaced the string ```your-npm-username``` with your real username.
Review the homepage, repository, license, and other supported package.json fields while you have the file open. Then open the README.md file and adjust the command in the Installation section so that it includes the full, username-prefixed package name you just included in the package.json file. For example:
```
jupyter labextension install @enki-portal/gitlab
```
Now run the following command to publish your package:
```
npm publish --access=public
```
Check that your package appears on the npm website. You can either search for it from the homepage or visit https://www.npmjs.com/package/@enki-portal/gitlab directly. If it doesn’t appear, make sure you’ve updated the package name properly in the package.json and run the npm command correctly. Compare your work with the state of the reference project at the 06-prepare-to-publish tag for further debugging.
\ No newline at end of file
{
"name": "@jupyterlab/gitlab",
"name": "@enki-portal/gitlab",
"version": "0.2.0",
"description": "A JupyterLab extension to access GitLab repositories",
"license": "BSD-3-Clause",
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment