{"id":17355127,"url":"https://github.com/zephinzer/annams","last_synced_at":"2025-07-19T13:07:06.961Z","repository":{"id":57180307,"uuid":"122814853","full_name":"zephinzer/annams","owner":"zephinzer","description":"Authentication \u0026\u0026 Authorization MicroService (ANNAMS) created for container-based deployment in a microservice architecture.","archived":false,"fork":false,"pushed_at":"2018-06-07T09:50:30.000Z","size":320,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-05T07:51:42.315Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zephinzer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-02-25T07:29:49.000Z","updated_at":"2018-06-07T09:50:32.000Z","dependencies_parsed_at":"2022-09-14T03:31:43.424Z","dependency_job_id":null,"html_url":"https://github.com/zephinzer/annams","commit_stats":null,"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"purl":"pkg:github/zephinzer/annams","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zephinzer%2Fannams","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zephinzer%2Fannams/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zephinzer%2Fannams/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zephinzer%2Fannams/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zephinzer","download_url":"https://codeload.github.com/zephinzer/annams/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zephinzer%2Fannams/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265937379,"owners_count":23852112,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-15T17:42:24.247Z","updated_at":"2025-07-19T13:07:06.920Z","avatar_url":"https://github.com/zephinzer.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ANNAMS\n**Authentication \u0026\u0026 Authorization MicroService** created for container-based deployments.\n\n[![Build Status](https://travis-ci.org/zephinzer/annams.svg?branch=master)](https://travis-ci.org/zephinzer/annams)\n[![Maintainability](https://api.codeclimate.com/v1/badges/ee6be816408e41b1f01f/maintainability)](https://codeclimate.com/github/zephinzer/annams/maintainability)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/ee6be816408e41b1f01f/test_coverage)](https://codeclimate.com/github/zephinzer/annams/test_coverage)\n\n1. [Authentication](#authentication)\n2. [Authorisation](#authorization)\n3. [MicroService](#microservice)\n\n## Documentation Index\n\n1. [Configuring Annams](./docs/configuration.md)\n2. [Deploying Annams](./docs/deployment.md)\n3. [REST-ful API](./docs/api-restful.md)\n4. [GraphQL API](./docs/api-graphql.md)\n5. [Contributing](./docs/contributing.md)\n\n## Annams Elsewhere\n- on CodeClimate @ https://codeclimate.com/github/zephinzer/annams\n- on DockerHub @ https://hub.docker.com/r/zephinzer/annams/\n- on GitHub @ https://github.com/zephinzer/annams\n- on NPM @ https://www.npmjs.com/package/annams\n- on Travis @ https://travis-ci.org/zephinzer/annams/\n\n## About ANNAMS\n### Authentication\nAuthentication is the process of knowing who a user is. Annams provides for the following methods of authenticating a user:\n\n- [ ] Email/password\n- [ ] Username/password\n- [ ] One-Time-Email\n- [ ] Via Facebook\n- [ ] Via Google\n\nTo keep Annams stateless, we utilise JSON Web Tokens (JWTs) which are signed using asymmetric keys.\n\n### Authorization\nAuthorization is the process of restricting access to content a user may access. Annams allows you to create Resource Types, Groups, and Accounts.\n\n1. Resource Types are atomic and can be assigned one or more Groups.\n2. Groups can be assigned one or more Accounts.\n3. Accounts belonging to a Group that has access to a Resource Type will be able to access the Resource Type, otherwise, access can be denied.\n\n### MicroService\nAnnams was created for deployment as part of a larger microservice architecture and accounts for both intra-network communications with other microservices, as well as communication with a client-side application. We implement the following features:\n\n- [x] Basic HTTP header security\n- [x] GZIP compressed responses\n- [x] Metrics collection/exposing (via Prometheus)\n- [x] Liveness Checks\n- [x] Readiness Checks\n- [x] Cross-Origin-Resource-Sharing (CORS)\n- [x] MicroServices compatible logging (via Pino)\n- [x] Containerisable (via Docker)\n- [x] Traceability (via Zipkin)\n- [ ] Support for Consumer Driven Contract (CDC) Testing (via Wiremock)\n- [ ] Virtual Machine Deployment Support (via PM2)\n- [ ] Container Deployment Support (via Docker)\n- [ ] Container Deployment Support (via Kubernetes)\n- [ ] REST-ful API\n\n### Future Development\nThe following are on the roadmap for future development:\n\n- [ ] HTTP/2 Compatibility\n- [ ] GraphQL API\n- [ ] Administrator Frontend\n\n## Architecture Notes\n### Primary Technologies\n- Shell Scripting\n- JavaScript (ES2017)\n- Docker\n- Kubernetes\n\n### Significant Frameworks/Libraries/Tools\n- App Framework : [Express](https://github.com/expressjs/express)\n- API Framework : [Swagger](https://swagger.io/)\n- Service Logger : [Pino](https://github.com/pinojs/pino)\n- Request Logger : [Morgan](https://github.com/expressjs/morgan)\n- Query Builder : [Knex](http://knexjs.org/)\n- Object Relational Mapper : [Objection.js](https://github.com/Vincit/objection.js/)\n- Test Framework : [Mocha](https://mochajs.org/)\n- Assertion Library : [Chai](http://chaijs.com/)\n- Test Coverage : [NYC](https://github.com/istanbuljs/nyc)\n- Code Quality Checker : [ESLint](https://eslint.org/)\n- Vulnerability Assessment : [NSP](https://github.com/nodesecurity/nsp)\n- Metrics : [Prometheus](https://prometheus.io/)\n- Request Tracing : [Zipkin](https://zipkin.io/)\n- Consumer Driven Contract Testing : [Wiremock](http://wiremock.org/)\n- Container Bundling : [Docker](https://www.docker.com/)\n- Continuous Integration : [Travis](https://travis-ci.org/)\n- Deployment : [PM2](https://github.com/Unitech/pm2) [Docker](https://www.docker.com/), [Kubernetes](https://kubernetes.io/)\n- Releases : [NPM](https://www.npmjs.com/), [GitHub](https://github.com), [DockerHub](https://hub.docker.com)\n\n### Third Party Services\n- [Code Climate](https://codeclimate.com) for code quality\n- [DockerHub](https://hub.docker.com) for container image hosting\n- [Travis](https://travis-ci.org) for continuous integration/delivery\n\n## License\n\nAnnams is licensed under the GPLv3 license.\n\n- - -\n\nAuthentication \u0026\u0026 Authorization MicroService (ANNAMS)\n\nCopyright (C) 2018 Joseph Matthias Goh (@zephinzer)\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program.  If not, see \u003chttps://www.gnu.org/licenses/\u003e.\n\n- - -\n\n# Cheers\n\n*(please contribute!)*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzephinzer%2Fannams","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzephinzer%2Fannams","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzephinzer%2Fannams/lists"}