Skip to content

Latest commit

 

History

History
86 lines (58 loc) · 2.1 KB

README.md

File metadata and controls

86 lines (58 loc) · 2.1 KB

Gitter API Dart Warpper

A Dart client library for accessing Gitter API.

CI-Tests Gitter

Getting Started

  1. Add this to your pubspec.yaml

    dependencies:
        tmdb_api: recent_version.
    
  2. Import the package in your code.

    import 'package:gitterapi/gitterapi.dart'
  3. Create instance of GitterApi.

    final gitterApi = GitterApi(ApiKeys('ACCESS_TOKEN'));

Example

Now use that instance to make api requests.

final Result<Map> result = await gitterApi.v1.userResource.me(); 
print(result.data);

// you can use models from gitterapi/models.dart to parse this data
final User me = User.fromMap(result.data);

🤝Wanna contributions to this package?

What you can contribute?

  • Add or update unit tests🧪.
  • Add or update documentation📝.
  • Found a new end point? create a issue and work on it🔗.
  • Check out good first issues🆕.

Resources

Note: Offical docs was not completely documented.

🔧Setup project for development

  1. Fork this repo. Then clone it.

    git clone https://github.com/{YOUR_GITHUB_USERNAME}/gitterapi.git
  2. Install dependencies.

    dart pub get
  3. Create a .env file for running tests.

    AUTH_TOKEN={YOUR TOKEN}
    USER_ID={YOUR USERID}
    ROOM_ID={SOME ROOM ID}
    CHAT_ROOM_ID={SOME GITTER ROOM ID}
    MESSAGE_ID={SOME MESSAGE ID}
    GROUP_ID={SOME GROUP ID}
    

Now you are ready to contribute.