Installations
npm install hashdoDeveloper Guide
Typescript
No
Module System
CommonJS
Min. Node Version
>=0.12.0
Node Version
10.5.0
NPM Version
6.1.0
Score
40.2
Supply Chain
84.2
Quality
69.6
Maintenance
25
Vulnerability
90.3
License
Releases
Unable to fetch releases
Contributors
Unable to fetch Contributors
Languages
JavaScript (83.02%)
CSS (16.36%)
HTML (0.62%)
Developer
Download Statistics
Total Downloads
46,647
Last Day
1
Last Week
38
Last Month
390
Last Year
1,564
GitHub Statistics
33 Stars
92 Commits
8 Forks
5 Watching
1 Branches
4 Contributors
Maintainers
Package Meta Information
Latest Version
0.10.77
Package Id
hashdo@0.10.77
Unpacked Size
188.53 kB
Size
52.39 kB
File Count
38
NPM Version
6.1.0
Node Version
10.5.0
Total Downloads
Cumulative downloads
Total Downloads
46,647
Last day
-85.7%
1
Compared to previous day
Last week
-61.2%
38
Compared to previous week
Last month
828.6%
390
Compared to previous month
Last year
-14.2%
1,564
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
16
#Do
#Do is framework for creating static or stateful interaction based cards that can be embedded in mobile applications or viewed in a browser. This is the base library that can be used in your own projects to generate, embed or serve #Do cards.
If you are looking for a way to create cards, get your hands on the #Do CLI which contains templates to quickly generate packs and cards as well as a test harness to easily test your card functionality.
Card examples can be found here: https://github.com/UXFoundry/hashdo-cards
Getting Started
Step 1
Install #Do into your project using NPM.
npm install hashdo --save
Step 2
Require it in your code.
var hashdo = require('hashdo');
Step 3
Generate the HTML, CSS and script necessary to render your card.
1hashdo.card.generateCard({
2 url: 'http://hashdo.com/restaurants/nearby',
3 directory: '/Where/Your/Cards/Are/Located',
4 packName: 'restaurants',
5 cardName: 'nearby',
6 inputValues: {
7 latitude: -29.837795,
8 longitude: 30.922539
9 }
10},
11// Callback containing an error or the HTML you can render.
12function (err, html) {
13 if (!err) {
14 // Do something with the HTML.
15 console.log(html);
16 }
17 else {
18 console.error(err);
19 }
20});Check out our open source #Do cards to test things out with or use the #Do CLI to create your own.
API
Packs
The packs module is accessible through hashdo.packs. This modules contains information about the packs and cards available.
Cards
The card module is accessible through hashdo.card. This module is used to secure inputs, generated card HTML and also perform the logic necessary for a web hook call.
Environment Variables
CARD_SECRET
Provide a value for this if you want to properly secure the URL and query parameters of a card.
LOCK_KEY
Provide a value for this if you want to properly secure input data in the database when using 'secureInputs'.
BASE_URL
Required if making use of client state. This will be the URL that cards will make HTTP calls to.
FIREBASE_URL
Use Firebase to update card state on the client when it changes. Without this the card will need to be refreshed manually to update it's client data.
Plugins
Modules can be replaced by your own implementations if necessary. Good examples of this are the data store or the analytics provider you wish to use.
The following plugins are available. If you have created your own plugins, let us know and we'll add links here.
Database
By default #Do uses an in-memory database. Card states and locks are lost when the application unloads but this is actually great for development and testing purposes.
MongoDB Plugin - Use this database plugin to persist your data to a MongoDB database.
Analytics
By default #Do has no analytics implementation. When an event is triggered it will output the details to the console.
Keen IO Analytics Plugin - Use this analytics plugin to send events to Keen IO.
To use a plugin, simply replace the exposed property with a new implementation. Each plugin's documentation will describe the requirements and the process of replacing the functionality.
View Engine Support
Currently #Do supports the following view engines.
Any view engine that Consolidate supports can be added as well if necessary. Using a view engine is not a requirement, you are welcome to use regular HTML.
CSS Preprocessor Support
Currently #Do supports the following CSS preprocessors.
Using a preprocessor is not a requirement, you are welcome to use regular CSS.
License
Copyright 2015 (c). All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
78 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-rvg8-pwq2-xj7q
- Warn: Project is vulnerable to: GHSA-pp7h-53gx-mx7r
- Warn: Project is vulnerable to: GHSA-832h-xg76-4gv6
- Warn: Project is vulnerable to: GHSA-wxhq-pm8v-cw75
- Warn: Project is vulnerable to: GHSA-4vmm-mhcq-4x9j
- Warn: Project is vulnerable to: GHSA-9vvw-cc9w-f27h
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-hr2v-3952-633q
- Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9
- Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2
- Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c
- Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5
- Warn: Project is vulnerable to: GHSA-qh2h-chj9-jffq
- Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
- Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
- Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
- Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
- Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
- Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
- Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
- Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
- Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
- Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
- Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq
- Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm
- Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-4hpf-3wq7-5rpr
- Warn: Project is vulnerable to: GHSA-f522-ffg8-j8r6
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-282f-qqgm-c34q
- Warn: Project is vulnerable to: GHSA-8cf7-32gw-wr33
- Warn: Project is vulnerable to: GHSA-hjrf-2m68-5959
- Warn: Project is vulnerable to: GHSA-qwph-4952-7xr6
- Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
- Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm
- Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
- Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-vfvf-mqq8-rwqc
- Warn: Project is vulnerable to: GHSA-7px7-7xjx-hxm8
- Warn: Project is vulnerable to: GHSA-x5pg-88wf-qq4p
- Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
- Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
- Warn: Project is vulnerable to: GHSA-hxm2-r34f-qmc5
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-w9mr-4mfr-499f
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-g6ww-v8xp-vmwg
- Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-gqgv-6jq5-jjj9
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
- Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
- Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3
- Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7
- Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
- Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-qhv9-728r-6jqg
- Warn: Project is vulnerable to: GHSA-g7q5-pjjr-gqvp
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
- Warn: Project is vulnerable to: GHSA-xc7v-wxcw-j472
- Warn: Project is vulnerable to: GHSA-34r7-q49f-h37c
- Warn: Project is vulnerable to: GHSA-c9f4-xj24-8jqx
- Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv
Score
1.7
/10
Last Scanned on 2025-01-27
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More