@alvarium/user-addresses

This project was bootstrapped with Create React App.

Bank Accounts (WebComponents)

This a web component to create and visualize user addresses.

Develop

To start a local version of the user-addresses component you need to execute the following commands:

First, make sure you have the latest version of the used libraries by executing:

yarn

Then, start the project with:

yarn start

This command should open a page in the browser with the url http://localhost:3000

Deployment

This component is deployed in a Gitlab Pages repository

Usage

To be able to use this repository in other projects you must add the script (JavaScript) and link (Styles) of the project.

To do so you just simply add the following lines of code to your index.html like so:

<link
  rel="stylesheet"
  href="https://alvarium-c.gitlab.io/user-addresses/static/css/main.css"
/>

<script 
  type="text/javascript"
  src="https://alvarium-c.gitlab.io/user-addresses/static/js/bundle.js"
/>

Then simply add the component wherever you want as so:

<user-addresses
  token='32434t45y56u354yh4t3t3g2342t2t'
  mapbox_token="5654rth45y4r3432344g334ff"
  endpoint='https://localhost'
  locale='es'
  user_id="4gt53gg433hy5323gg"
/>

token (string|uuid): The token for the user-addresses service.

mapbox_token (string|uuid): The token for the mapbox api.

endpoint (string): The endpoint of the user-addresses service.

locale (string): The language in which the user-addresses should be displayed.

user_id (string|uuid): The id of the user to display and assign user-addresses.