-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#3 Explain for each module how to set up OAuth Apps
- Loading branch information
Showing
4 changed files
with
91 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
CampaignChain Twitter Packages | ||
============================== | ||
|
||
This documentation covers the standard Twitter functionality available by | ||
default in the CampaignChain Community Edition. | ||
|
||
Features | ||
-------- | ||
|
||
- Connect a Twitter stream to CampaignChain with username and password | ||
- Assign a Twitter message to a campaign | ||
- Schedule a Tweet to automatically post it on Twitter at a given date and time | ||
- Assign a responsible person to a Tweet | ||
- Once a Tweet was posted, regularly collect statistical data about likes | ||
and re-tweets | ||
|
||
Packages | ||
-------- | ||
|
||
The standard Twitter functionality is being provided by CampaignChain, Inc. | ||
through these packages: | ||
|
||
- `campaignchain/channel-twitter`_ | ||
- `campaignchain/location-twitter`_ | ||
- `campaignchain/activity-twitter`_ | ||
- `campaignchain/operation-twitter`_ | ||
|
||
Although these modules are based on `Symfony bundles`_, they do not work | ||
independently of CampaignChain. | ||
|
||
Installation | ||
------------ | ||
|
||
The above modules are included in the Community Edition by default. | ||
|
||
Configuration | ||
------------- | ||
|
||
.. _Twitter OAuth app configuration: | ||
|
||
Before you can post on Twitter from within CampaignChain, an OAuth app must be | ||
created in Twitter: | ||
|
||
#. Go to https://dev.twitter.com/apps and create a new application. | ||
#. Fill out any required fields such as the application name and description. | ||
#. Put your website domain in the Website field. | ||
#. Provide the domain of your CampaignChain instance as the Callback URL. Make | ||
sure that you specify the correct protocol (`http` or `https`). | ||
#. Once you have registered the app, `connect to a location`_ while choosing | ||
Twitter as the Channel. | ||
#. When the *Provide Application Credentials* screen comes up, go back to | ||
https://dev.twitter.com/apps, select your app and visit the the *Keys and | ||
Access Tokens* tab to copy and paste the *Consumer Key* and the *Consumer | ||
Secret* and insert it in the *Provide Application Credentials* form. | ||
|
||
Issues | ||
------ | ||
|
||
Please post reports, questions, suggestions, etc. at | ||
https://github.com/CampaignChain/campaignchain/issues. | ||
|
||
|
||
.. _campaignchain/channel-twitter: https://github.com/CampaignChain/channel-twitter | ||
.. _campaignchain/location-twitter: https://github.com/CampaignChain/location-twitter | ||
.. _campaignchain/activity-twitter: https://github.com/CampaignChain/activity-twitter | ||
.. _campaignchain/operation-twitter: https://github.com/CampaignChain/operation-twitter | ||
.. _Symfony bundles: http://symfony.com/doc/current/bundles.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,4 +7,5 @@ available for CampaignChain. | |
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
campaignchain_twitter | ||
campaignchain_update |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters