Merge tag '1.0.0-alpha.3'

CampaignChain · Dec 8, 2014 · 8443680 · 8443680
2 parents 0f47eb2 + d7d0822
commit 8443680
Show file tree

Hide file tree

Showing 4 changed files with 69 additions and 88 deletions.
diff --git a/administrator/include/_configure_scheduler.rst.inc b/administrator/include/_configure_scheduler.rst.inc
@@ -6,7 +6,7 @@ every minute:
 .. code-block:: bash
 
     $ crontab -e -u <username>
-    */1 * * * * /usr/bin/php /path/to/symfony2/app/console campaignchain:scheduler
+    */1 * * * * /usr/bin/php /path/to/campaignchain/app/console campaignchain:scheduler
 
 On Windows, you could use the `task scheduler or AT command`_ to achieve the same.
 

diff --git a/administrator/installation/ce.rst b/administrator/installation/ce.rst
@@ -12,130 +12,87 @@ can quickly try CampaignChain.
 2. Ensure that your MySQL server is running.
 
 1. Download CampaignChain
---------------------------
+-------------------------
 
 Download the Community Edition from `www.campaignchain.com/download`_.
 
 Extract the contents of the archive to a directory on your system.
 
-2. Set up Database
--------------------
-
-Launch the MySQL command-line client and create a new MySQL database for the
-application.
-
-.. code-block:: mysql
-
-    CREATE DATABASE campaignchain_db;
+Make sure that PHP has access to all files in the CampaignChain directory. On
+Linux, you could issue this command:
 
-At the same time, create a user with full privileges to the new database, as
-shown below:
-
-.. code-block:: mysql
+.. code-block:: bash
 
-    GRANT ALL on campaignchain_db.* TO 'campaignchain'@'%' IDENTIFIED BY 'gue55me';
+    $ chown -R www-data:www-data /path/to/campaignchain
 
-Edit the *app/config/parameters.yml* file and define the database host, name,
-user and password.
+... with ``www-data`` being the HTTP server's user and group, respectively.
 
-*Example:*
+2. Set up Database
+------------------
 
-.. code-block:: yaml
+Launch your MySQL client of choice and create a new MySQL database for the
+application.
 
-    parameters:
-        database_driver: pdo_mysql
-        database_host: 127.0.0.1
-        database_port: null
-        database_name: campaignchain_db
-        database_user: campaignchain
-        database_password: gue55me
+3. Install Composer
+-------------------
 
-From within the application's root directory, issue the following command which
-will create the table structures in the database:
+CampaignChain utilizes `Composer`_ for its package and modules management. Install
+it with this command:
 
 .. code-block:: bash
 
-    $ php app/console doctrine:schema:update --force
+    $ curl -sS https://getcomposer.org/installer | php
 
-3. Register Apps with Various Online Channels
------------------------------------------------
+4. Install Base System
+----------------------
 
-To be able to post to Twitter, Facebook and LinkedIn from within CampaignChain,
-register an App with these three services, by following the steps below:
+In the root of CampaignChain, execute this command (not as root user!):
 
-1. Go to the following pages:
-
-   - Twitter: https://apps.twitter.com
-   - Facebook: https://developers.facebook.com/apps
-   - LinkedIn: https://www.linkedin.com/secure/developer
-
-2. Fill out any required fields.
-
-Once you have registered a new app, you will receive a key and secret that will
-be displayed to you under above pages.
-
-Now, open the sample data file *vendor/campaignchain/distribution-ce/Resources/data/campaignchain/ce.yml*
-and replace the text ``replaceme`` with the app key and secret provided by Twitter,
-Facebook and LinkedIn.
+.. code-block:: bash
 
-.. code-block:: yaml
+    $ composer install
 
-    # vendor/campaignchain/distribution-ce/Resources/data/campaignchain/ce.yml
-    \CampaignChain\Security\Authentication\Client\OAuthBundle\Entity\Application:
-        application1:
-            resourceOwner: Twitter
-            # Specify your Twitter Consumer Key and Secret here:
-            key: replaceme
-            secret: replaceme
-        application2:
-            resourceOwner: Facebook
-            # Specify your Facebook App key and secret here:
-            key: replaceme
-            secret: replaceme
-        application3:
-            resourceOwner: LinkedIn
-            # Specify your Facebook App key and secret here:
-            key: replaceme
-            secret: replaceme
+It will download and install all required packages and modules for the
+CampaignChain base system. Please note that this might take a while.
 
-Next, execute the below command to load the above sample data into CampaignChain:
+At the end of the process, you will be asked in the command line to provide some
+configuration parameters. Please make sure you check/provide at least the
+following (default values in brackets):
 
 .. code-block:: bash
 
-    $ php app/console h4cc_alice_fixtures:load:files --manager=default --type=yaml --seed=42 vendor/campaignchain/distribution-ce/Resources/data/campaignchain/ce.yml
+    database_driver (pdo_mysql):
+    database_host (127.0.0.1):
+    database_port (null):
+    database_name (campaignchain_ce):
+    database_user (root):
+    database_password (null):
+    java_path (/usr/bin/java):
 
-4. Configure CampaignChain Scheduler
--------------------------------------
 
-.. include:: ../include/_configure_scheduler.rst.inc
-
-5. Get Bitly Access Token
---------------------------
+5. Configure CampaignChain Scheduler
+------------------------------------
 
-.. include:: ../include/_get_bitly_access_token.rst.inc
+.. include:: ../include/_configure_scheduler.rst.inc
 
 6. Start Server
----------------------
+---------------
 
 Use PHP's built-in Web server to run CampaignChain.
 
 .. code-block:: bash
 
     $ php app/console server:run
 
-7. Log In to CampaignChain
----------------------------
-
-Point your Web browser to http://localhost:8000/ and log in with:
+7. Installation Wizard
+----------------------
 
-- **username**: admin
-- **password**: test
+Hop over to http://localhost:8000/campaignchain/install.php and follow the instructions.
 
 8. Install Modules
---------------------
+------------------
 
-Visit the module installation screen at http://localhost:8000/system/modules/
-and install all modules.
+You can easily add modules (e.g. to post on Twitter or Facebook) at http://localhost:8000/modules/new/.
 
 Success!
 --------
@@ -147,4 +104,5 @@ To make full use of CampaignChain's capabilities, you could now
 1. :doc:`Configure Call to Action (CTA) tracking <../configuration/cta>`
 2. :doc:`Learn how to create your first campaign and activity </user/get_started>`
 
-.. _www.campaignchain.com/download: http://www.campaignchain.com/download
+.. _www.campaignchain.com/download: http://www.campaignchain.com/download
+.. _Composer: https://getcomposer.org/download/
diff --git a/administrator/installation/dev.rst b/administrator/installation/dev.rst
@@ -141,6 +141,8 @@ bundles.
     new CampaignChain\Hook\DurationBundle\CampaignChainHookDurationBundle(),
     new Hpatoio\BitlyBundle\HpatoioBitlyBundle(),
     new Sp\BowerBundle\SpBowerBundle(),
+    new Sonata\CoreBundle\SonataCoreBundle(),
+    new Sonata\BlockBundle\SonataBlockBundle(),
 
 If you have previously specified additional CampaignChain packages in
 *composer.json*, then make sure you also register them here.
@@ -260,6 +262,16 @@ configurations below.
         bundles:
             CampaignChainCoreBundle: ~
 
+    sonata_block:
+        default_contexts: [sonata_page_bundle]
+        blocks:
+            sonata.block.service.text:
+            sonata.block.service.rss:
+            campaignchain.block.activity.upcoming.listgroup:
+            campaignchain.block.milestone.upcoming.listgroup:
+            campaignchain.block.campaign.ongoing.listgroup:
+            campaignchain.block.rss:
+
 4.5 Create *assetic.yml*
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -355,6 +367,7 @@ content.
         dhtmlxgantt_css:
             inputs:
                 - '@CampaignChainCoreBundle/Resources/public/components/gantt/codebase/dhtmlxgantt.css'
+                - '@CampaignChainCoreBundle/Resources/public/css/campaignchain/dhtmlxgantt.css'
         flot_js:
             inputs:
                 - '@CampaignChainCoreBundle/Resources/public/components/flot/jquery.flot.js'
@@ -375,6 +388,10 @@ content.
         fullcalendar_css:
             inputs:
                 - '@CampaignChainCoreBundle/Resources/public/components/fullcalendar/dist/fullcalendar.css'
+                - '@CampaignChainCoreBundle/Resources/public/css/campaignchain/fullcalendar.css'
+        countdown_js:
+            inputs:
+                - '@CampaignChainCoreBundle/Resources/public/components/jquery.countdown/dist/jquery.countdown.js'
       bundles:
         - CampaignChainCoreBundle
         - CampaignChainReportAnalyticsMetricsPerActivityBundle
@@ -431,6 +448,12 @@ the below configuration.
             - { path: ^/register, role: IS_AUTHENTICATED_ANONYMOUSLY }
             - { path: ^/resetting, role: IS_AUTHENTICATED_ANONYMOUSLY }
 
+            # REST API
+            - { path: ^/api/v1/.*, roles: IS_AUTHENTICATED_ANONYMOUSLY }
+
+            # Installer
+            - { path: ^/install/.*, role: CAMPAIGNCHAIN_INSTALL }
+
             # Secured part of the site
             - { path: ^/, role: ROLE_USER }
             - { path: ^/, roles: IS_AUTHENTICATED_ANONYMOUSLY }

diff --git a/conf.py b/conf.py
@@ -55,9 +55,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.0.0-alpha.1'
+version = '1.0.0-alpha.3'
 # The full version, including alpha/beta/rc tags.
-release = '1.0.0-alpha.2'
+release = '1.0.0-alpha.3'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.