_{A platform to help students & teachers in their daily tasks.}

Features

• OAuth2 authentication
• REST API for users, posts, ...
• Generated API documentation
• Linting and unit testing

Stack used

• Symfony 3.2
• Doctrine 2.5
• FOSUserBundle 2.0
• PHP 5.6

Getting started

Requirements

• composer
• Apache server with PHP 5.6+
• A recent MySQL server

Installation

git clone https://github.com/jclerc/colibrique-server.git
cd colibrique-server
# Install dependencies
composer install
# Install database
sf db:seed
# Start server
sf server:run

Notes

Testing code compliance

# Symfony code convention
sf code:lint
# as alias of: vendor/bin/phpcs --standard=vendor/escapestudios/symfony2-coding-standard/Symfony2 src

# Unit tests
sf code:test
# as alias of: vendor/phpunit/phpunit/phpunit src

API documentation

• The OAuth2 endpoint for authentication is /oauth/v2/token
• For the documentation of the other methods, take a look at /api/doc