umg-open-day/README.md

Project for open day in 2020

<h1>umg-open-day</h1>
<h2>Project for open day in Gdynia Maritime University in 2020</h2>

<table>
<tr>
<td colspan='2'>
<h2>List of usefull npm commands:</h2>
</td>
</tr>
<tr>
<td>
Item
</td>
<td>
Description
</td>
</tr>

<tr>
<td><pre>
npm publish
</pre>
</td>
<td>
publishes the package to npm
</td>
</tr>

<tr>
<td><pre>
npm unpublish
</pre></td>
<td>
deletes package from npm
</td>
</tr>

<tr>
<td><pre>
npm login
</pre></td>
<td>
logs in to npm
</td>
</tr>

<tr>
<td><pre>
npm logout
</pre></td>
<td>
logs out of npm
</td>
</tr>
</table>

<table>
<tr>
<td colspan='3'>
<h2>Package json:</h2>
</td>
</tr>
<tr>
<td>
Attribute
</td>
<td>
Description
</td>
<td>
Example
</td>
</tr>

<tr>
<td><pre>
name
</pre>
</td>
<td>
name of the package
</td>
<td><pre>"name": "umg-open-day"
</pre>
</td>
</tr>

<tr>
<td><pre>
version
</pre></td>
<td>
current package version
</td>
<td><pre>"version": "1.0.1"
</pre>
</td>
</tr>

<tr>
<td><pre>
description
</pre></td>
<td>
package description
</td>
<td><pre>"description": "Project for umg open day 2020"
</pre>
</td>
</tr>

<tr>
<td><pre>
main
</pre></td>
<td>
exported babeled file
</td>
<td><pre>"main": "index.js"
</pre>
</td>
</tr>

<tr>
<td><pre>
author
</pre></td>
<td>
author of the package
</td>
<td><pre>"author": "Tomasz Muchowski, Jakub Przybylski, Albert Zawadzki"
</pre>
</td>
</tr>

<tr>
<td><pre>
license
</pre></td>
<td>
type of license which allows to use this package
</td>
<td><pre>"license": "BeerWare"
</pre>
</td>
</tr>

<tr>
<td><pre>
repository
</pre></td>
<td>
repository with packages code
</td>
<td><pre>"repository": {
  "type": "git",
  "url": "https://github.com/AlbertZawadzki/umg-open-day"
}
</pre>
</td>
</tr>

<tr>
<td><pre>
keywords
</pre></td>
<td>
helps package to be easier to find
</td>
<td><pre>"keywords": [
  "umg",
  "gdynia",
  "maritime",
  "university",
  "project"
]
</pre>
</td>
</tr>

<tr>
<td><pre>
homepage
</pre></td>
<td>
homepage of the package
</td>
<td><pre>"homepage": "https://github.com/AlbertZawadzki/umg-open-day"
</pre>
</td>
</tr>

<tr>
<td><pre>
bugs
</pre></td>
<td>
link to report packages vulnerabity
</td>
<td><pre>"bugs": {
  "url": "https://github.com/AlbertZawadzki/umg-open-day/issues"
}
</pre>
</td>
</tr>

<tr>
<td><pre>
scripts
</pre></td>
<td>
you can add there tests, dev mode commands.<br/>
<i>The most important command is build</i> - it compiles your code from ES6+ to clear ES5. Instead folderWithComponents put your folder with ready components.
</td>
<td><pre>"scripts": {
  "build": "./node_modules/.bin/babel folderWithComponents --out-file index.js"
}
</pre>
</td>
</tr>
</table>