Hulk (IAM)

IAM (Hulk) Hulk is an Identity and Access Management (IAM) solution that leverages Node.js and TypeScript to provide a secure and scalable architecture. It utilizes a combination of PostgreSQL and Redis as data storage and caching layers, respectively. By deploying Hulk on Kubernetes using Docker containers, it achieves high availability and seamless scalability. With its robust design, Hulk ensures the management of user identities, authentication, and authorization, enforcing security policies and access controls in compliance with FAPI and Open Banking specifications. This IAM solution serves as a central component in the architecture, enabling a secure and controlled environment for user access and management.Hulk is an Identity and Access Management (IAM) solution that leverages Node.js and TypeScript to provide a secure and scalable architecture. It utilizes a combination of PostgreSQL and Redis as data storage and caching layers, respectively. By deploying Hulk on Kubernetes using Docker containers, it achieves high availability and seamless scalability. With its robust design, Hulk ensures the management of user identities, authentication, and authorization, enforcing security policies and access controls in compliance with FAPI and Open Banking specifications. This IAM solution serves as a central component in the architecture, enabling a secure and controlled environment for user access and management.

Based on a template for an API using Fastify. Written in TypeScript.

Contributions

1. Clone the repo

2. Checkout into a new branch with the proper name (feature/xx, refactor/xx, chore/xx... etc.)

3. Write your code + tests (required) and/or update documentation

4. Push changes to the remote branch

5. Create a PR and notify a maintainer and enjoy your day!

Important Docs

• Fastify
• Encapsulation
• Routes
• Plugins
• Logging
• Validation & Serialization
• Hooks
• Swagger Specification
• JSON Schema Specification

Project Structure

.
├── .github # Github specific files (dependabot, workflows... etc.)
├── .husky # husky dir (Readonly)
├── data # contains data for seeding the data
├── server # contains the main files for the backend
│   ├── config # stores configurations (server, logger, env vars... etc.)
│   ├── models # Objection.js models
│   ├── plugins # Custom plugins (auth, security, cache, db... etc.)
│   ├── routes # routes must be place here and versioned
│   │   └── v1 # example version
│   │       ├── accounts # exports subroutes under '/accounts/'
│   │       │   ├── index.js # exports routes login, register and token (and others)
│   │       │   ├── login # example route, mapped to '/api/v1/accounts/login'
│   │       │   │   ├── index.js
│   │       │   │   └── spec.json # JSON schema spec of the login route
│   │       │   ├── register # example route, mapped to '/api/v1/accounts/register'
│   │       │   │   ├── index.js
│   │       │   │   └── spec.json # JSON schema spec of the register route
│   │       │   └── token # example route, mapped to '/api/v1/accounts/token'
│   │       │       ├── index.js
│   │       │       └── spec.json # JSON schema spec of the token route
│   │       └── index.js # exports accounts routes (and others)
│   └── static # contains static assets (robots.txt)
└── tests # written tests go here

Requirements

• Node.js
• Optional: docker & docker-compose

Development

$ yarn dev
# run in development

$ yarn start
# run in production

$ yarn lint
# check for errors

$ yarn fix
# fix any errors

$ yarn test
# run tests

Running tests locally

Most tests are ran using our CI (GitHub Actions), but to replicate testing, run the following:

$ docker-compose -f docker-compose.ci.yml up -d
# should download the images and run them in their respective ports

$ export $(cat .env.testing) && npm run test
# inject the testing env vars and run tests

Environment

See .env.template

License

See LICENSE.md