Skip to content

OpenBankProject/OBP-Portal

Repository files navigation

Getting Started

Install dependencies

npm install

Configure Environment

copy .env.example to .env and fill out as needed

Developing

Once you've created a project and installed dependencies with npm install (or pnpm install or yarn), start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Building

To create a production version of your app:

npm run build

You can preview the production build with npm run preview.

To deploy your app, you may need to install an adapter for your target environment.

Deploying in production

Make sure to deploy the latest commit/docker image.

Look carefully at the .env.example provided, Copy to .env (.env-docker) and fill out the variables as needed.

A common mistake is to not change the APP_CALLBACK_URL, which should be the domain that the portal is deployed to, not localhost.

Make sure that the APP_CALLBACK_URL is registered with the OAuth2/OIDC provider, so that it will properly redirect. Without this the Portal will not work.

About

Some new Portal and Consent pages (WIP) Note: The main Portal functionality is currently in OBP-API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •