Yesferal Auth Node

This is an authentication module used in all Yesferal Cueva projects.

Create a NodeJS project

Create a new NodeJs project.

npm init

Use TS instead of JS

We will install TS and @types/node as dev dependencies, but you can skip all this section if you are planning to use JS instead.

npm i -D typescript -g

npm install @types/node --save-dev 

Init TSC, this is going to create a tsconfig.json file that we should modify.

tsc --init 

We should uncomment the next line inside the tsconfig.json file in order to get a custom JS and TS performance.

"outDir": "lib",

and append the include block after compilerOptions block.

"compilerOptions": {
     ...
},
"include": [
    "src"
]

Update the scripts value inside the package.json file in order to build and run easily, but this is just an optional step.

"build": "npx tsc",
"dev": "node lib/index.js",

Install NPM dependencies

First, this project needs Git and Node JS previously installed, the steps for installation depend on the OS you have.

Then, you should clone the repository.

Finally, you need to install the project dependencies like typescript, bcrypt or passport.

npm install

Build the project

Open a terminal and run build in order to generate JS code based on the TS one

npm run build

Run the JS compiled project and check if the code is correct.

npm run dev 

Publish the project

Bump version

Update package.json version value and run install command to update package-lock.json version too

npm install

Get all the changes and put them on CHANGELOG.md file

git log --pretty="- %s (%h)"

Finally, publish the changes

npm publish --access public

License

Copyright 2020 Bet-NodeJs Contributors

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

     https://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.