@getfursure/astra-js-sdk v1.0.0-alpha.14

About The Project

Astra currently does not offer an official JavaScript SDK for their HTTP/s API

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Installation & Setup

1. Get your keys from Astra for the Client Id and Client Secret
2. Install

   npm install @getfursure/astra-js-sdk --save
   # OR
   yarn add @getfursure/astra-js-sdk

3. Basic Usage

   import { Astra } from '@getfursure/astra-js-sdk'
   const astraClient = new Astra(
     {
      baseUrl: '',
      clientId: '',
      clientSecret: '',
    }
   );
   astraClient.auth.createAccessToken(...);

Usage

Please refer to the Documentation

Roadmap

• Documentation
• Routines Resource
• Cards Resource
• Testing
• Linting and Formating

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.md for more information.

Contact

Open an issue https://github.com/getfursure/astra-js-sdk/issues

Acknowledgments