cekurte/twitter-like

Twitter like message application

v1.0.0 2016-05-19 01:51 UTC

Requires

• php: >=5.6
• cekurte/environment: ^0.2
• cekurte/resource-manager: ^0.0
• cekurte/silex-manager-provider: ^0.0
• dflydev/doctrine-orm-service-provider: ~1.0
• gedmo/doctrine-extensions: ^2.4
• jdesrosiers/silex-cors-provider: ^0.1
• jdesrosiers/silex-jms-serializer-provider: ^0.1
• saxulum/saxulum-validator-provider: ^1.1
• silex/silex: ^1.3
• symfony/console: ^2.8
• symfony/twig-bridge: ^3.0
• symfony/validator: ^3.0
• twig/twig: ^1.20
• vlucas/phpdotenv: ^2.2

Requires (Dev)

• cekurte/tdd: ^1.0
• phpunit/phpunit: ^4.8
• sensiolabs/security-checker: ^3.0
• sjparkinson/static-review: ~5.1
• squizlabs/php_codesniffer: ^2.5

MIT

• João Paulo Cercal

README

• Just another simple web application that can be used to test the integration between the AngularJS and Silex PHP micro framework. So, this project is a cool and simplest version of Twitter micro blogging with a web responsible interface (thanks TwitterBootstrap) and with a REST API provided by Silex (thanks SensioLabs), contribute with this project!

Installation

• The package is available on Packagist.
• The source files is PSR-2 compatible.
• Autoloading is PSR-4 compatible.

git clone https://github.com/jpcercal/twitter-like.git
cd twitter-like/
composer install
bower install
npm install
mkdir -p storage/cache
chmod +x app/console
chmod -Rf 777 storage/
cp .env.example .env

# change your database credentials
nano .env

grunt
# run "grunt production" to minify and optimize the web files

Now, you must create a MySQL database named twitter_like (this name can be changed in your .env file). After, you must type the command on your terminal:

php app/console orm:schema-tool:create

This command will create the entities on your MySQL database.

Running a Web Server

After the steps that you followed to install this application, you must run a web server. So, type the following command on your terminal to create a web server.

$ php -S 0.0.0.0:8080 -t public/ public/index.php

Note that this command must be executed on root directory of this web application.

Now you can open your browser and access the application http://localhost:8080/ that looks like with the following screenshot:

API Documentation

Well, you can see below the HTTP routes where this application will handle your requests.

GET / will load the web application.

GET /api/post will load the posts from database in two format and return the results in two different formats (json or xml).

[
    {
        "id":5,
        "created_at":"2016-05-19 01:24:34",
        "message":"Could you help me, please?"
    },
    {
        "id":4,
        "created_at":"2016-05-19 01:24:01",
        "message":"I'm a ZCPE (Zend Certified PHP Engineer) and I work with PHP since 2010."
    },
    {
        "id":3,
        "created_at":"2016-05-19 01:23:19",
        "message":"Hey guys, good morning!"
    },
    {
        "id":2,
        "created_at":"2016-05-19 01:23:04",
        "message":"Hello, how are you?"
    },
    {
        "id":1,
        "created_at":"2016-05-19 01:22:52",
        "message":"My first message."
    }
]

Or in XML if you send a request with the Accept header with the value text/xml:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <entry id="5" created_at="2016-05-19 01:24:34">
        <![CDATA[Could you help me, please?]]>
    </entry>
    <entry id="4" created_at="2016-05-19 01:24:01">
        <![CDATA[I'm a ZCPE (Zend Certified PHP Engineer) and I work with PHP since 2010.]]>
    </entry>
    <entry id="3" created_at="2016-05-19 01:23:19">
        <![CDATA[Hey guys, good morning!]]>
    </entry>
    <entry id="2" created_at="2016-05-19 01:23:04">
        <![CDATA[Hello, how are you?]]>
    </entry>
    <entry id="1" created_at="2016-05-19 01:22:52">
        <![CDATA[My first message.]]>
    </entry>
</result>

POST /api/post will receive a content type as application/json with the following content:

{
    "message":"Could you help me, please?"
}

This request will create a resource on your entity Post and will return a response where the content type will be application/json with the following content:

{
    "id": 6,
    "created_at": "2016-05-19 01:24:34",
    "message": "Could you help me, please?"
}

If you liked of this project, give me a star =).

Contributing

1. Give me a star =)
2. Fork it
3. Create your feature branch (git checkout -b my-new-feature)
4. Make your changes
5. Run the tests, adding new ones for your own code if necessary (vendor/bin/phpunit)
6. Commit your changes (git commit -am 'Added some feature')
7. Push to the branch (git push origin my-new-feature)
8. Create new Pull Request