A Twitter client, built on Electron
To use Surfbird, either download one of the pre-built releases or build the client yourself using the instructions provided below.
Note: Surfbird is in no way feature-complete and might be broken for some users. Current provided releases are for testing purposes!
- node.js (latest stable should work)
- Twitter App Tokens with following settings:
- Permissions: Read, Write and Access direct messages
- Sign in with Twitter: No
First, clone the repository using following command:
git clone --recursive git@github.com:surfbirdapp/surfbird.git
Alternatively, if you already cloned the repository, you can just run:
git submodule init
git submodule update
This is to get all required submodules, currently only consisting of the client assets, which you need for the client to properly display stuff, or even display anything.
Copy surfbird.example.json to surfbird.json, add your keys and then run following commands:
npm installgulp assetsnpm start
Information about callback_url: It pretty much does not matter what URL you use here, as long
as it can hold get parameters without removing them, the client only needs to be able to grab them.
npm run build:[windows|linux|osx]
Surfbird is following the Javascript Standard Styleguide
You are always free to report bugs or request new features with opening an issue on the issue tracker, but please do yourself and the team the favor of searching for your bug/request before opening another issue for something that might already exist!
Want to add a new feature yourself? That's awesome!
You are always free to contribute new features to Surfbird, the most important thing being that you keep the projects structure intact (or if you have a better solution, open an issue and let us discuss!) and also adhere to Javascript Standard style.
You can easily check this with running npm run lint and you'll get all style errors printed out for you! If
there are nits you can't really fix that easily, leave them be and just mention that in your Pull Request!
Other than that you are perfectly ready to submit your PR, have fun contributing!
Surfbird is licensed under the MIT License