An open API service indexing awesome lists of open source software.

https://github.com/luistar/studeo

Studeo is a basic CMS built for university courses. It allows students to share news and knowledge efficiently.
https://github.com/luistar/studeo

cakephp php phpbb students

Last synced: 16 days ago
JSON representation

Studeo is a basic CMS built for university courses. It allows students to share news and knowledge efficiently.

Awesome Lists containing this project

README

          

# Studeo
Studeo is a basic CMS built for university courses. It allows students to share news and knowledge efficiently.

# The problem
Computer Science students @ *Università degli Studi di Napoli "Federico II"* were using
a phpbb board to share solutions to previous tests and exercises. As the number of users and solutions grew, it became hard to
properly index everything manually. So we decided to build Studeo.

# PhpBB integration and dependency
Studeo is meant to integrate with an existing phpbb board bulletin and to provide additional indexing features to said board.
Although being conceived to be used along with phpbb, Studeo will be almost completely independent from the latter,
as it will provide indexing by link.
Only the authentication and authorization system will initially depend on phpbb USERS table.
Other options shall be added as the project grows.

# Technology
Studeo is built using CakePHP, Twitter Bootstrap, JQuery, MySQL.

# Quick setup
Clone this repository, then run ```composer install``` to install dependencies.
By default Studeo will look for two MySQL databases in *localhost:3306*:

* Studeo's database.
* phpBB's database.

Connection to those can be customized in /config/app.php, by editing the following parts:
```php
'Datasources' => [
'default' => [
'className' => 'Cake\Database\Connection',
'driver' => 'Cake\Database\Driver\Mysql',
'persistent' => false,
'host' => 'localhost',
//'port' => 'non_standard_port_number',
'username' => 'studeo',
'password' => 'studeo',
'database' => 'studeo',
'encoding' => 'utf8',
'timezone' => 'UTC',
'flags' => [],
'cacheMetadata' => true,
'log' => false,
'quoteIdentifiers' => false,
//'init' => ['SET GLOBAL innodb_stats_on_metadata = 0'],
'url' => env('DATABASE_URL', null),
],
/**
* Connection to the phpbb database.
*/
'phpbb_db' => [
'className' => 'Cake\Database\Connection',
'driver' => 'Cake\Database\Driver\Mysql',
'persistent' => false,
'host' => 'localhost',
//'port' => 'non_standard_port_number',
'username' => 'phpbb',
'password' => 'phpbb',
'database' => 'phpbb',
'encoding' => 'utf8',
'timezone' => 'UTC',
'flags' => [],
'cacheMetadata' => true,
'log' => false,
'quoteIdentifiers' => false,
//'init' => ['SET GLOBAL innodb_stats_on_metadata = 0'],
'url' => env('DATABASE_URL', null),
'phpbbTablePrefix' => 'phpbb',
],
```
The /sql/studeo_db_create.sql script will build the necessary database structure.
If one does not wish to install phpbb locally for testing purposes (recommended), it is possible to run the /sql/phpbb_user.sql script to create a phpbb schema. The default users table provides the following users:
* username: **admin** password: **password**
* username: **user** password: **password**

#Contribution guidelines
Please, write comments, commit messages and variable/table/column names in English! Issues can be submitted in italian, too.