Skip to content

AT Protocol and Bluesky things for Dart and Flutter 🎯

License

Notifications You must be signed in to change notification settings

atprotodart/atproto.dart

Β 
Β 

Repository files navigation

bluesky

AT Protocol and Bluesky Social Things for Dart/Flutter 🎯


GitHub Sponsor GitHub Sponsor melos Netlify Status

Test/Analyzer codecov Issues Pull Requests Stars Contributors Code size Last Commits License Contributor Covenant


1. Guide 🌎

The packages in this monorepo will minimize your learning time about AT Protocol and Bluesky things, and maximize your Dart/Flutter development productivity with AT Protocol and Bluesky things.

Give a ⭐ on this repository to activate a project!

github_star

1.1. Packages & Tools

1.1.1. Dart & Flutter

Name pub.dev Description
at_identifier pub package Provide standard validation for identifier supported by AT Protocol to Dart/Flutter.
nsid pub package Provide standard NSID object supported by AT Protocol to Dart/Flutter.
at_uri pub package Provide standard uri supported by AT Protocol to Dart/Flutter.
xrpc pub package Provide an HTTP client specialized for XRPC communication in AT Protocol.
multiformats pub package Provide useful interfaces such a CID used by AT Protocol to Dart/Flutter.
atproto_core pub package Provide core reusable and useful functionality for wrapping AT Protocol and related services.
lexicon pub package Provide AT Protocol standard lexicon objects for Dart/Flutter.
atproto pub package Provide the easiest and powerful way to use com.atproto lexicons in Dart/Flutter.
bluesky_text pub package Provides the easiest and most powerful way to analyze the text on Bluesky Social.
bluesky pub package Provide the easiest and powerful way to use app.bsky lexicons in Dart/Flutter.

1.1.2. Flutter

Name pub.dev Description
bluesky_cards pub package Provide a widget to output Bluesky Social's post content beautifully in Flutter app.

1.1.3. CLI

Name pub.dev Description
bluesky_cli pub package CLI tool to easily use Bluesky Social's APIs from the command line.

1.1.4. GitHub Actions

Name Marketplace Description
bluesky_post bluesky-post Use this action to send a post to Bluesky Social from GitHub actions workflow.

1.3. Melos Commands

This project consists of several packages and is managed using Melos.

First you need to install Melos with following command.

dart pub global activate melos

Then, the Melos commands available for this project are:

Command Description
melos get Run pub get command in this project.
melos analyze Run dart analyze in all packages.
melos format Run dart format in all packages.
melos import_sorter Run dart run import_sorter:main in all packages.
melos build_runner Run build_runner and melos format in all packages. You can generate *.g.dart and *.freezed.dart objects with this command.
melos test Run all Dart & Flutter tests in this project.
melos test:dart Run Dart tests for a specific package in this project.
melos test:flutter Run Flutter tests for a specific package in this project.
melos publish_all Run publish for all packages, create a git tag and push it to origin.

1.4. Contribution πŸ†

If you would like to contribute to atproto.dart, please create an issue or create a Pull Request.

There are many ways to contribute to the OSS. For example, the following subjects can be considered:

  • There are request parameters or response fields that are not implemented.
  • Documentation is outdated or incomplete.
  • Have a better way or idea to achieve the functionality.
  • etc...

You can see more details from resources below:

Or you can create a discussion if you like.

Feel free to join this development, diverse opinions make software better!

1.5. Contributors ✨

Thanks goes to these wonderful people (emoji key):

Shinya Kato / εŠ θ—€ 真也
Shinya Kato / εŠ θ—€ 真也

πŸ’» πŸ–‹ πŸ› πŸ“– πŸ”£ 🎨 πŸ’‘ πŸš‡ 🚧 πŸ“† πŸ“£ πŸ‘€ πŸ›‘οΈ πŸ”§ ⚠️ βœ…
tacsotai
tacsotai

πŸ€”
Luke Pighetti
Luke Pighetti

πŸ€” πŸ›
Alice
Alice

πŸ€” πŸ“¦
videah
videah

πŸ€” πŸ› πŸ“¦ πŸ’¬ πŸ““
redsolver
redsolver

πŸ€” πŸ› πŸ’¬
Shy Ruparel
Shy Ruparel

πŸ€”
Julien
Julien "uj" Abadji

πŸ’»
maughtchiner
maughtchiner

πŸ€” πŸ–‹
igz0
igz0

πŸ€” πŸ–‹

This project follows the all-contributors specification. Contributions of any kind welcome!

1.6. Support ❀️

The simplest way to show us your support is by giving the project a star at GitHub and Pub.dev.

You can also support this project by becoming a sponsor on GitHub:

1.7. License πŸ”‘

The source code provided in this monorepo is is provided under the BSD-3 license.

Copyright 2023 Shinya Kato. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided the conditions.

Note
License notices in the source are strictly validated based on .github/header-checker-lint.yml. Please check header-checker-lint.yml for the permitted standards.

1.8. More Information 🧐

All resources in atproto.dart is maintained by Shinya Kato (@myConsciousness).

About

AT Protocol and Bluesky things for Dart and Flutter 🎯

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Dart 96.2%
  • TypeScript 1.3%
  • C++ 0.8%
  • CMake 0.6%
  • JavaScript 0.4%
  • SCSS 0.3%
  • Other 0.4%