Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Installable odash #27

Merged
merged 28 commits into from
May 8, 2018
Merged

Installable odash #27

merged 28 commits into from
May 8, 2018

Conversation

tolu
Copy link
Contributor

@tolu tolu commented May 8, 2018

Fix Odashboard so that people can install it as a dependency instead of forking the entire repo.

Solution

  • use path.join
  • add .npmignore to avoid pushing unused files
  • test with npm pack and (in another directory) npm i -S ../Odashboard/odashboard-0.0.1.tgz
  • set up publishing

Usage example

In my-dashboard dir, run

npm i odashboard -S

Folder structure
Add required config files like so:

my-dashboard/
├── config/
│   ├── widgets.js
│   └── data.js
└── package.json

package.json
Add scripts to start like so:

{
	"scripts": {
		"start": "odashboard -w config/widgets.js -d config/data.js"
	}
}

@tolu tolu self-assigned this May 8, 2018
@tolu
Copy link
Contributor Author

tolu commented May 8, 2018

published pre-release to https://www.npmjs.com/package/@nrk/odashboard

(need to be logged in to npm to see)

publishing can be done via travis if we should want to, but for now it might be ok to publish manually using npm run release

@tolu tolu merged commit 503ac24 into master May 8, 2018
@tolu tolu deleted the installable-odash branch May 8, 2018 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants