Merge pull request #10 from SecJS/feat/len-add-ci

feat: Add CI

Author: jlenon7

.github/workflows/cd.yml

@@ -22,13 +22,10 @@ jobs:
           registry-url: 'https://registry.npmjs.org'
 
       - name: Download dependencies
-        run: yarn
-
-      - name: Run the tests inside project
-        run: yarn test
+        run: npm install
 
       - name: Transpile typescript to javascript
-        run: yarn build
+        run: npm run build
 
       - name: Automatic GitHub Release
         uses: justincy/github-action-npm-release@2.0.1
@@ -39,4 +36,4 @@ jobs:
         if: steps.release.outputs.released == 'true'
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-          name: Deploy
+          name: Deploy

.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI Http
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+
+    runs-on: ubuntu-18.04
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '14.x'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Download dependencies
+        run: npm install
+
+      - name: Verify project lint and try to fix it
+        run: npm run lint:fix
+
+      - name: Run the tests from project
+        run: npm run test

.gitignore

@@ -1,40 +1,124 @@
-# compiled output
-node_modules
 
+node_modules/
+dist/
 # Logs
 logs
 *.log
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
+.pnpm-debug.log*
 
-# OS
-.DS_Store
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 
-# Tests
-/coverage
-/.nyc_output
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
 
-# IDEs and editors
-/.idea
-.project
-.classpath
-.c9/
-.env.testing
-*.launch
-.settings/
-*.sublime-workspace
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
 
-# IDE - VSCode
-.vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
 
-.env
-*.js
-*.d.ts
-build
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
 
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# IDE
+.idea
+.vscode
+
+# dotenv environment variables file
+.env
+.env.testing
+.env.production

README.md

@@ -23,8 +23,15 @@ The intention behind this repository is to always maintain a `Http` package to a
 
 ## Installation
 
+> To use the high potential from @secjs/http you need to install first this packages from SecJS,
+> it keeps as dev dependency because one day @secjs/core will install everything once.
+
+```bash
+npm install @secjs/contracts @secjs/utils
+```
+
 ```bash
-yarn add @secjs/http
+npm install @secjs/http
 ```
 
 ## Usage