Skip to content

huasteka/zacatzontli

Repository files navigation

Zacatzontli

CircleCI Maintainability Test Coverage

Zacatzontli is an open source lightweight authentication manager API developed with Node JS.

Setup

The minimum requirements are:

Installation

To download and build the project, open a terminal and execute:

git clone https://github.com/huasteka/yacatecuhtli.git
cd yacatecuhtli
npm install

With this, all dependencies will be installed at node_modules directory.

Configuration

Change the default values at config/datastores.js or set the required environment variables:

DATABASE_URL=[postgres_db_connection_url]
JWT_SECRET_KEY=[jwt_secret_key]
BCRYPT_PASSWORD_SALT=[bcrypt_password_salt]

Tests

To execute all tests, open a terminal and execute:

npm test

Run

To run the server, open a terminal and execute:

node app.js

License

Zacatzontli is Copyright © 2017 Huasteka.

It is free software, and may be redistributed under the terms specified in the LICENSE.md