Cryptum SDK: PHP Version

Table of Contents

• Table of Contents
• About Project
• Starting
  • Installation
    • Requirements for install
    • Language used
    • Commons steps for Dev
    • Commons steps to use
  • How To Use
    • Configuration
• Contributing
  • What does my PR need to be accepted ? 🤔
• License
• Contact

About Project

This project is to provide an integration with the Cryptum backend. This project calls Cryptum API using Clean Architecture and PHP.

Starting

Installation

Requirements for install

• PHP 7.3
• Composer version 2.1.3

Language used

• PHP

Commons steps for Dev

Open your project

cd cryptum-sdk-php/

Install using composer manager

composer install

Add an alias to run phpunit

alias phpunit='./vendor/bin/phpunit

Commons steps to use

Open your project

cd my-amazing-project/

Install using composer manager

composer install cryptum-sdk

How To Use

Below is an short description using code how you can use cryptum-sdk to integrate your amazing application with us.

Configuration

To configure cryptum-sdk you need only provide an config in format JSON.

const CryptumSDK = require('cryptum-sdk')

const sdk = new CryptumSDK({
  config: {
    enviroment: 'development',
    apiKey: 'my-secret-api-key',
  },
})

To see environments available you can see here:

Environments available
development
production

Contributing

Contributions are what make the open source community an incredible place to learn, inspire and create. Any contribution you make will be much appreciated.

1. Make a project Fork
2. Create a Branch for your feature (git checkout -b feature/amazing-feature)
3. Insert your changes (git add .)
4. Make a commit with your changes (git commit -m 'feat(<folder-name>): Inserting a Amazing Feature !)
5. Push the branch (git push origin feature/amazing-feature)
6. Open a Pull Request

What does my PR need to be accepted ? 🤔

In order for us to accept your PR, you need to adhere to the following standards.

1. Create using the code pattern currently used in cryptum-sdk
2. Test your update and show artifacts in PR.

It's all 🤷🏻‍♂️

License

Distributed under the MIT license. See LICENSE for more information.

Contact

Blockforce - SITE - [email protected]