# nodedemoapp

> This App is made to show steps to go for your own npm install

Latest version **0.0.3** (published 2015-03-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install nodedemoapp
pnpm add nodedemoapp
yarn add nodedemoapp
bun add nodedemoapp
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2015-03-06 |
| First published | 2015-02-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Student007 |
| Maintainers | student007 |
| Keywords | node, npm, demo |

## Links

- npm: https://www.npmjs.com/package/nodedemoapp
- Repository: https://github.com/Student007/nodedemoapp
- Issues: https://github.com/Student007/nodedemoapp/issues
- npm.io page: https://npm.io/package/nodedemoapp

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.0.3 (latest) — 2015-03-06
- 0.0.2 — 2015-03-06
- 0.0.1 — 2015-02-17

## README

[![Stories in Ready](https://badge.waffle.io/Student007/nodedemoapp.png?label=ready&title=Ready)](https://waffle.io/Student007/nodedemoapp)
[![Build Status](https://travis-ci.org/Student007/nodedemoapp.svg?branch=master)](https://travis-ci.org/Student007/nodedemoapp)
# Node Demo App

Shows the world the steps to go to get proud to have your own ```npm install nodedemoapp```

1) Create a new project on https://github.com/new

2) Clone your new repository by downloading/unzip or
```git clone https://github.com/yourGithubUserName/repositoryName.git```

3) Create a NPM Account either by ```npm adduser``` or at https://npmjs.org/signup

4) login by ```npm login``` 

5) Within your local repository: create a package.json (you can use the ```npm init``` command what walks you through)

6) Create a server.js including the planed module
```
 exports.hello = function(who){
		console.log('Hello '+who);
	};
```

7) commit it to your repository by `git add *`, `git commit -m "your comment"` and `git push origin master`

8) where your ```package.json``` is located execute ```npm publish```

If you see ```+nodedemoapp``` you have done well :-)

9) If you like to change the readme on npmjs.com, you need to change the version in `package.json`, `git commit -m "..."`, `git push origin master` and run `npm publish`

If you see e.g. `+ nodedemoapp@1.0.1` you have done well :-)


# Try it

To use your first own node module you simple create a test.js
```
var demo = require('nodedemoapp');
demo.hello('GitHub');
```

Don't forget to install the module before executing ```node test.js```
```
npm install nodedemoapp
```

Or you could add a dependancy to your package.json
```
"dependencies": {
    "nodedemoapp": "0.0.3"
}

```
and install your app by ```npm install``` within your directory

# Testing

To test whether the module works itself you can download the archive, extract the zip and execute the following with the created folder:
```
npm test
```

Because of the scripts part within package.json the bash script ```test```
will be executed 
```
"scripts": {
    "test": "for f in tests/*; do echo \"$f\"; node \"$f\"; done; echo 'Test state is OK'; exit 0"
  },
```
In our example test case it executes code of tests/requireModueTest.js 
```
var mod = require('../server.js');
try {
	mod.hello('Testing User - Method exists (Test successful)');
}
catch (err){
	console.log('something doesn\'t work well (Test failed)');
}
```

# Reporting
It is recommended to show badges and graphs about activities and state of the progress behind the module or library. If you like to have badges and shields in the same fitting size you can go to http://shields.io/ or use their new [tool](https://github.com/badges/badgerbadgerbadger).

A collection of badges you can find [here](https://github.com/boennemann/badges).

Professionals are working with (agile) project management frameworks. So you also could use scrum directly within your GitHub by [Waffle.io](http://waffle.io) and show an issue based chart. 

**Note:** It would be a good idea to add an extra repository for things are not issues maybe 

Badges like [![Stories in Ready](https://badge.waffle.io/Student007/nodedemoapp.png?label=ready&title=Ready)](https://waffle.io/Student007/nodedemoapp)
[![Stories in Progress](https://badge.waffle.io/Student007/nodedemoapp.png?label=progress&title=Progress)](https://waffle.io/Student007/nodedemoapp)
came from Waffle.io same as project metrics based on issue labels (what can be added by your individual needs):

[![Throughput Graph](https://graphs.waffle.io/Student007/koa-sub-domain/throughput.svg)](https://waffle.io/Student007/koa-sub-domain/metrics)

---
_Source: https://npm.io/package/nodedemoapp · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._