@adyen/adyen-platform-experience-web 1.0.0 → 1.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Adyen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,69 @@
+![Platform Experience header](https://github.com/Adyen/adyen-platform-experience-web/assets/7926613/18094965-9e01-450e-8dc9-ea84e6b22c2b)
+
+# Adyen Platform Experience
+
+[![npm](https://img.shields.io/npm/v/@adyen/adyen-platform-experience-web.svg)](http://npm.im/@adyen/adyen-platform-experience-web)
+
+Adyen Platform Experience provides you with the building blocks to create an internal dashboard for your platform customers.
+
+## Prerequisites
+
+-   [Adyen test account](https://www.adyen.com/signup)
+-   [API key](https://docs.adyen.com/development-resources/how-to-get-the-api-key)
+
+## Installation
+
+We only provide full support when you use one of these methods of installation.
+
+### Node package manager
+
+1. Install the [Adyen Platform Experience Node package](https://www.npmjs.com/package/@adyen/adyen-platform-experience-web):
+
+```sh
+npm install @adyen/adyen-platform-experience-web --save
+```
+
+2. Import Adyen Platform Experience into your application:
+
+```js
+import AdyenPlatformExperience from '@adyen/adyen-platform-experience-web';
+```
+
+## Development
+
+To run the development environment:
+
+1. Clone [this repository](https://github.com/Adyen/adyen-platform-experience-web).
+2. Create a `.env` file on your project's root folder following the example in [`env.default`](envs/env.default) and fill in the environment variables.
+3. Install the dependencies by running:
+
+```sh
+npm install
+```
+
+4. Run the development environment, which starts a server listening on [http://localhost:3030](http://localhost:3030):
+
+```sh
+npm start
+```
+
+## Contributing
+
+We merge every pull request into the `main` branch. We aim to keep `main` in good shape, which allows us to release a new version whenever we need to.
+
+Have a look at our [contributing guidelines](https://github.com/Adyen/.github/blob/main/CONTRIBUTING.md) to find out how to raise a pull request.
+
+## See also
+
+-   [Documentation](https://docs.adyen.com/)
+-   [API Explorer](https://docs.adyen.com/api-explorer/)
+
+## Support
+
+If you have a feature request, or spotted a bug or a technical problem, [create an issue here](https://github.com/Adyen/adyen-platform-experience-web/issues/new/choose).
+
+For other questions, [contact our support team](https://www.adyen.help/hc/en-us/requests/new).
+
+## License
+
+This repository is available under the [MIT license](LICENSE).