https://github.com/bibekaryal86/auth-service

User Management with Roles and Permissions for Multiple Applications
https://github.com/bibekaryal86/auth-service

Last synced: 1 day ago
JSON representation

User Management with Roles and Permissions for Multiple Applications

• Host: GitHub
• URL: https://github.com/bibekaryal86/auth-service
• Owner: bibekaryal86
• Created: 2024-06-24T23:24:18.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-11-28T03:46:30.000Z (2 months ago)
• Last Synced: 2024-11-28T04:26:35.099Z (2 months ago)
• Language: Java
• Homepage:
• Size: 195 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# auth-service

A small utility for authentication and authorization with platforms, profiles, roles and permissions management

## Local Development

* Navigate to project root

* `./gradlew bootrun`

* The bootrun process reads environment variables from gcp folder's `app-credentials.yaml` file

* There is an example `app-credentials_DUMMY.yaml` file provided, create `app-credentials.yaml` file and update values

* These environment variables are checked during application start, and if not present the application won't start

* During the build process, these variables are used in flyway and bootrun scripts

* Flyway

  * Run flyway command as `./gradlew flywayMigrate`

    * For first run, append `-Dflyway.baselineOnMigrate=true` to set baseline migration

  * Clear database (DELETES EVERYTHING)

    * `./gradlew flywayClean -Dflyway.cleanDisabled=false`

  * Flyway migration is configured to not trigger automatically, it only validates

    * This means that migration command needs to be given manually

  * Flyway migration is controlled via github actions to main DB branch

  * There are 2 database instances created to support local development and production data

    This app uses free tier of `tembo.io` for database services utilizing postgres

    So, for this service, there are two Postgres instances in `cl7529129` organization

      * `auth-service`

          * This instance is used for production instance

        * When a pull request is merged to main branch, flyway migration is run in this branch

      * `auth-service-sandbox`

        * This branch is used for local/development instances

        * When a pull request is created, flyway migration is run in this branch to validate schema changes

* TODO

  * Update this README.md for proper documentation

  * Implement RequestMetadata, ResponseCrudInfo