https://github.com/xrobert35/univ-auth

Simple authentication server
https://github.com/xrobert35/univ-auth

Last synced: 25 days ago
JSON representation

Simple authentication server

• Host: GitHub
• URL: https://github.com/xrobert35/univ-auth
• Owner: xrobert35
• Created: 2018-08-12T17:56:04.000Z (over 6 years ago)
• Default Branch: develop
• Last Pushed: 2018-10-27T14:57:40.000Z (about 6 years ago)
• Last Synced: 2024-10-12T15:01:33.957Z (3 months ago)
• Language: TypeScript
• Size: 179 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
## Univ Auth

[![GitHub version](https://badge.fury.io/gh/xrobert35%2Funiv-auth.svg)](https://github.com/xrobert35/univ-auth)

[![Coverage Status](https://coveralls.io/repos/github/xrobert35/univ-auth/badge.svg)](https://coveralls.io/github/xrobert35/univ-auth)

[![Build Status](https://travis-ci.org/xrobert35/univ-auth.svg?branch=develop)](https://travis-ci.org/xrobert35/univ-auth)

[![GitHub version](https://img.shields.io/badge/licence-MIT-green.svg)](https://github.com/xrobert35/univ-auth)

## General informations

This project is a simple authentitacion server

## Usefull informations

### Launching project

This project can be launch by doing  **npm run start**

You can also use the existing **vscode** configuration

You will need a mongodb to make it work, you can 

#### Script package.json

| Commande   | Description    |

| ------------ | ------------ |

| start  |  Launch the project |

| start:prod | Launch the builded project in prod mode   |

| build  | Build the project  |

| test | Launch all jest test |

| test:unit |  Launch jest unit test |

| test:e2e |  Launch jest e2e test |

### Configuration

By default the project is configured thanks to **src/config/default.js**

This configuration can be overrided by another file if you specify another one thanks to **NODE_ENV**

Exemple NODE_ENV=development  will load the **default.js** and will override it with **src/config/development.js**

#### Usable environment var

|  Variable | Description   |

| ------------ | ------------ |

| MONGO_URL   | Mongo URL   |

| SERVER_PORT | Server PORT |

| SERVER_PATH | Server base path |

| LOG_LEVEL  |  Log level |

| AUTH_TOKEN_NAME  |  Auth token name |

| AUTH_JWT_KEY  |  Private key used to encrypt the jwt token |

| SWAGGER_ACTIVATED | active or not the swagger |

| ADMIN_ACCOUNT | admin login |

| ADMIN_PWD | admin password |

#### Used framework links :

- nestjs : https://docs.nestjs.com/controllers