https://github.com/julien-c/Circular

An open source Buffer app clone
https://github.com/julien-c/Circular

buffer tweet-scheduling twitter

Last synced: 9 days ago
JSON representation

An open source Buffer app clone

• Host: GitHub
• URL: https://github.com/julien-c/Circular
• Owner: julien-c
• License: mit
• Archived: true
• Created: 2012-07-27T10:26:26.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2016-04-17T12:58:19.000Z (about 8 years ago)
• Last Synced: 2024-04-14T18:16:19.996Z (2 months ago)
• Topics: buffer, tweet-scheduling, twitter
• Language: HTML
• Homepage: http://circular.io
• Size: 2.48 MB
• Stars: 1,025
• Watchers: 74
• Forks: 194
• Open Issues: 46
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-stars - Circular - c | 1023 | (HTML)
• awesome-stars - Circular - c | 1026 | (HTML)
• awesome-stars - Circular - An open source Buffer app clone (HTML)
• awesome-stars - Circular - An open source Buffer app clone (HTML)
• awesome-stars - julien-c/Circular - An open source Buffer app clone (HTML)

README

        
# Circular

#### An open source Buffer app built on Backbone, Bootstrap and MongoDB

http://circular.io

---

Circular is built as a Backbone.js application that communicates with a MongoDB datastore through a REST API written in PHP. 

The server part, based on the [Silex](http://silex.sensiolabs.org) PHP micro-framework and the [Mongovel](http://github.com/julien-c/Mongovel) wrapper to MongoDB, is intended to be the *dumbest possible*, i.e. we tried to put most "intelligence" in the Backbone app, not in the API. (For example, the API only takes UNIX timestamps and posts' content, while the Backbone app computes the scheduled timestamps).

A daemon based on [PHP-Daemon](https://github.com/shaneharter/PHP-Daemon) then runs in the background and is responsible for sending your posts to Twitter when they're due.

### Installation

---

Prerequisites:

* MongoDB, and PHP's [MongoDB driver](http://www.mongodb.org/display/DOCS/PHP+Language+Center)

* To run the background daemon based on [PHP-Daemon](https://github.com/shaneharter/PHP-Daemon), you need the POSIX and PCNTL extensions for PHP.

* [Composer](http://getcomposer.org)

Installation:

* Make sure you cloned this repo recursively, i.e. with submodules that are in `extlib`

* Create a new Twitter application on dev.twitter.com, then copy your credentials into `api/config.php.sample` and rename it to `api/config.php`

  * Make sure to specify an OAuth callback URL in your Twitter application settings. Use `http://[server_name]/[path to buffer]/api/oauth.php`

* Install the Silex application dependencies using Composer: `cd api && composer install`

* Create an `uploads` directory and make it writable by the Web server

* Your application's frontend should now be accessible where you set it up, for instance at `http://localhost/Circular`. The MongoDB datastore's name will be `circular` (you don't have to explicitly create it).

* Start the daemon with `php Daemon/run.php` 

  * Use option `-d` to run as daemon, i.e. detach and run in the background

  * Your daemon's log will be in `/var/log/daemons/circular`, or if this is not writable, in `Daemon/logs`. You can use/rotate this log to monitor your daemon.

* That's it!

### License

---

* Copyright 2012 [Julien Chaumond](http://julien-c.fr)

* Distributed under the [MIT License](http://creativecommons.org/licenses/MIT/)