Skip to content

Latest commit

 

History

History
118 lines (91 loc) · 7.2 KB

README.md

File metadata and controls

118 lines (91 loc) · 7.2 KB
Raw

Opioner-frontend

Complete codebase for Opioner frontend web app

MAKEFILE CI Security CI Node.js CI SonarCloud analysis

Goal - MAKE YOUR OPINION COUNT AND SHARE WITH WORLD

http://opioner-home.vercel.app/

Opioner-frontend-docker-app

This project is meant to maintain the frontend code for the Opioner - Make Your Opinion Count And Share With World.

@Live

  • [Latest deployments] Deployed on Render cloud hosting platform instance.
    @Deprecated
  • [Older versions] The project is deployed using Github servers and all requests are served through Github API gateway. @Deprecated
  • [Latest versions] The Current versions are deployed using vercel platform which is integrated with master branch.
    @Deprecated
  • Backend of Opioner app(private repo) is served through Heroku servers.
    @Deprecated
  • [Latest versions] The Current versions are deployed using Heroku platform which is integrated with master branch.

Deliverables

This project contains two types of deliverables : @Deprecated

  • Vanilla JS webapp (no framework) [The last released version is 6.0.0]
    @Live
  • Express powered dockerized webapp [Versions starting from 7.0.0]
    Latest Docker image

Github CI pipeline:

  • Every push to master branch triggers github Makefile CI actions workflow which builds, test and deploy container images.
  • Additional CI checks are introduced for Nodejs CI builds, SONAR code quality checks.
  • Cypress is integrated for GUI test automation.

Planned releases

Status Description Comments
✔️ Username and Password form authentication Basic username, password authentication. Users and passwords (hashed) maintained in opioner DB.
✔️ Add Google/FB Sign-in custom providers flow Custom setup for google, facebook sign-in flows using individual clients (OIDC). Application knows about direct clients integrated.
✔️ JWT token based (custom) JWT token generation in frontend code, token validation in backend for service to service communication authz
✔️ JWT token based (keycloak based) + Google/FB 3rd party Identity providers flow Sign-In using Keycloak (OIDC Oauth authorization server), use keycloak generated token. Application only knews about keycloak and not direct clients, keycloak internally will managed google/fb clients integration flows. Tokens are stored in sessionStorage (no way currently to store in-memory) locally in browser. Once logged out or tabs closed, tokens are not persisted.
🚩 Cookie based auth for token Tokens storage needs to be removed from sessionStorage and use cookie based mechanisms
🚩 RBAC role based access control

Running project locally:

DEMO (Preview of all features)

This is an image This is an image This is an image This is an image This is an image This is an image This is an image This is an image This is an image This is an image This is an image This is an image

Easy configuration

  • For local development and production, both configuration can be handled using js/config.js where hosts/URL for staging, local and production can be managed. Currently, config.js is random localhost ports which is expected by devs to inject/update the values when the opioner-backend services are up accordingly.

ENV VARIABLES FOR RUNNING (before starting the service):

  • SECRET_KEY
  • PORT
  • NODE_ENV
  • DEBUG
  • LOG_LEVEL
  • AUTH_SERVICE_URL
  • USER_SERVICE_URL
  • PRODUCT_SERVICE_URL
  • NOTIFICATION_SERVICE_URL

Keycloak based authentication and authorization

  • All routes are protected with JWT based token authentication which is expected by client to send in Authorization headers.
  • Tokens are issued by Keycloak which acts as identity broker and uses social logins which are identity providers (IdP).
  • Currently, browser authorization code flow is used.
  • Access tokens are issued by Keycloak and ID tokens are issued by IdP.
  • All environment variables are just default values, actual values are injected on the fly while deployment (not commited due to security reasons).

Notes

  • All the routes are served by express backend server including static files using middleware and other configured routes.
  • Frontend and backend layers are decoupled such that frontend only concerns about public views and backend controllers and services concerns how to call actual backend and take care of authn and authz required to invoke API's.

I bet you will love the backend of the project, check it here Opioner-backend

GDPR compliance:

All the data processed for user is transparent and is explained on terms and privacy policy page of (Opioner-home website)[https://souravs17031999.github.io/opioner-home]

whats next ? Deployment using k8s via dockerized image (use npm package manager, better security, react components)