Git Product home page Git Product logo

users-auth-api-boilerplate's Introduction

Nevezide - Authentication API

Requirements

  • NodeJS engine
  • PostgreSQL engine with 2 DBs : school and school_test

The package contains

Setup

Copy .env.sample to .env Set .env variables, as following conditions :

NODE_ENV = # prod | dev
API_PORT = # API listening port
TOKEN_SECRET = # Salt for JWT signature
TOKEN_EXPIRATION = # JWT expiration delay (ex: 1800s for 30 minutes)

PROD_DATABASE_URL = # Production | Dev DB connection string (as postgres://user:password@localhost:5432/school)
TEST_DATABASE_URL = # Test DB connection string (as postgres://user:password@localhost:5432/school_test)

Build it for production

docker build -t nevezide44/users-auth-api-boilerplate -f Dockerfile .
docker login -u "nevezide44" -p "<access_token>" docker.io
docker push nevezide44/users-auth-api-boilerplate

Use it

Install dependencies

npm i

Migrate the DB

db-migrate up

Launch it for developement

npm start

Test and Develop it

Test with coverage audit

npm test

Will generate a report into the terminal For more readable reportings, check the doc : https://github.com/bcoe/c8

Test driven developement

npm run tdd

Further information

Mocha test framework : https://mochajs.org/#getting-started Chai assertions : https://www.chaijs.com/api/assert/ Test coverage options and reportings : https://github.com/bcoe/c8

users-auth-api-boilerplate's People

Watchers

Nathan G. avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.