Skip to content

About

A repository for sample apps build using Buffer API

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

19 Commits

Folders and files

Repository files navigation

Buffer Sample Apps

A collection of sample applications that show how to build on the Buffer API. Each sample is a small, self-contained project you can clone, run, and use as a starting point for your own build.

Note: These samples are meant for learning and prototyping. Make sure to review and adapt them to your own security, error-handling, and scaling needs before using them in production.

Samples

Sample What it shows Stack
App client starter app A third-party app that connects a Buffer account over OAuth 2.0 with PKCE, lists its channels, and adds a draft post to a channel's queue. Node.js, Express

Prerequisites

  • A Buffer account
  • API access credentials. See the Buffer developer docs for how to get them.
  • Any language-specific tooling listed in the sample's own README

Repository structure

All sample apps live in the samples/ directory. Each one has its own folder with everything it needs to run:

.
├── samples/
│   ├── sample-app-name/
│   │   ├── README.md        # Setup and usage instructions for this sample
│   │   ├── .env.example     # Environment variables the sample needs
│   │   └── ...              # Source code
│   └── another-sample/
│       └── ...
├── CONTRIBUTING.md
├── LICENSE
└── README.md

Run a sample app

  1. Clone the repository:

    git clone https://github.com/bufferapp/buffer-sample-apps.git
    cd buffer-sample-apps
  2. Move into the sample you want to try:

    cd samples/sample-app-name
  3. Follow the setup instructions in that sample's README.md.

Never commit your API credentials. Each sample reads them from environment variables: copy .env.example to .env and fill in your own values.

Resources

Contributing

These sample apps are provided as-is for educational purposes. They're maintained on a best-effort basis and aren't covered by Buffer's product support or service-level agreements.

See CONTRIBUTING.md for what we accept and how to contribute.

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

A repository for sample apps build using Buffer API

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors