Get started

VoteFirst documentation

Put your public roadmap, your changelog and your feature voting inside your own product, on your own pages, under your own design.

There are three ways in, and most people only ever need the first.

Most people start here Embed the widgets One script tag and one line of JavaScript render a working board in your page. No server, no build step, nothing to keep in sync. Quickstart iOS and macOS Add the Swift package The same board as a screen in your app, from one key and one line. It works offline, and it brings its own navigation. Quickstart For custom interfaces Use the API The same board as JSON, so you can render it exactly the way your product renders everything else, or move data in and out of it. Quickstart

What you can embed

Nine widgets, each one call. Every one of them draws real elements into your own page rather than an iframe, so your stylesheet, your fonts and your developer tools reach all of it. The roadmap board and the changelog are where most pages start.

Roadmap board. Your columns, your cards, and a vote control on the ones that take votes.
Changelog. Your published releases and what shipped in each.
Most Wanted list. A ranked list of what people are asking for.
Vote button and badge. One feature's vote control, to sit beside the feature itself in your interface.
Suggestion and problem report popups. Opened from any button on your page.

See all nine, with the code for each.

They wear your board's colours by default, they say whatever you want them to say, in whatever language, and a page that would rather draw its own interface can take the data alone.

Inside an iOS or macOS app

The Swift package puts the same board on a screen. It takes your embed key and nothing else, brings its own navigation so it works on a tab or in a sheet, and wears your board's colours the way the widgets do.

Votes made with no signal are kept and sent when the connection comes back, and everything the screens do is a call your own interface can make instead.

Put a board in your app in three steps.

What you need

Three credentials, all of them in the dashboard under Share & Embed. They are not interchangeable, and only the first belongs in a web page.

Credential	Where it goes	What it opens
`Embed key`	In your page, or your app	Public by design. It opens what your public board already shows, and nothing else.
`SSO secret`	On your server	Signs tokens that say who a visitor is, so votes land under your own users.
`API key`	On your server	Reads and writes this one project through the API.

Who your voters are

Nobody embedding a board has to make their visitors sign up for anything. A visitor votes, comes back a week later, and their votes are still theirs, without an account and without a cookie banner.

If the people using your product are already signed in to it, you can carry that identity across, and every vote and comment is recorded against the person who left it. That takes a token your server signs, and it is the one part of this that needs a backend.

Four quickstarts

They are four different jobs and none of them is a step of another. Each is three steps and each ends with something working.

Embed quickstart A live board in one of your own pages, from a script tag. Swift quickstart A board on a screen in your iOS or macOS app. SSO quickstart Your signed in users voting under their real names. API quickstart Your first read and your first write, as curl commands.