Skip to content

Latest commit

 

History

History
63 lines (47 loc) · 2.09 KB

README.md

File metadata and controls

63 lines (47 loc) · 2.09 KB
Raw

Arcio Authentication

Credits

  • @JohnCosta27 For the majority of this authentication system
  • @Acorn221 For tests, the register endpoint and many bug fixes

This repo is to setup the authentication for the arcio systems.

ci Statements Branches Functions Lines

Getting Started

npm install
npm run dev

The public/private key paths are relative to the root of the project. If you want to add them outside the project do: ../

.env content

DATABASE_URL=postgresql://user:[email protected]:port/db_name
JWT_SECRET=SharedSecretWithBackend
LOG_DIR=./directory_to_store_logs/
ROTATING_LOG_FILE_NAME=auth-%DATE%.log
AUDIT_FILE_NAME=auditFile.json
LOG_EXPIRY_TIME=365d
PORT=5000
PRIVATE_KEY=path/to/private
PUBLIC_KEY=path/to/public

Commit rules

Husky is setup to inforce commit rules through CommitLint

You must write your commits in the following format:

type(scope?): subject

types:

  • ci (Changes to the CI configuration files and scripts)
  • chore (Other changes that don't modify src or test files)
  • docs (Changes to documentation files)
  • feat (A new feature that has been added)
  • fix (A fix that has been made)
  • perf (A change relating to performance)
  • refactor (A code change that neither fixes a bug nor adds a feature)
  • revert (Reverting a previous commit/change)
  • style (A change that is relating to code style)
  • test (Any new tests or adjustments to them)

examples:

chore: enabled commit linting
ci(app.ts): commiting progress on express server

Click here to find out more