maintainerati / bikeshed
Maintainerati Open Space note taker
Installs: 9
Dependents: 0
Suggesters: 0
Security: 0
Stars: 7
Watchers: 1
Forks: 0
Open Issues: 2
pkg:composer/maintainerati/bikeshed
Requires
- php: ^7.2
- ext-intl: *
- ext-json: *
- ext-pdo: *
- api-platform/core: ^2.1
- doctrine/annotations: ^1.0
- doctrine/orm: ^2.5.11
- erusev/parsedown: ^1.7
- ezyang/htmlpurifier: ^4.10
- hostnet/form-handler-component: ^1.5.3
- knplabs/knp-menu: ^2.3
- limenius/liform: ^0.12.0
- ramsey/uuid-doctrine: ^1.5
- rollerworks/password-strength-validator: ^1.1
- swiftmailer/swiftmailer: ^6.1.3
- symfony/asset: ^4.3
- symfony/console: ^4.3
- symfony/form: ^4.3
- symfony/http-client: ^4.3
- symfony/security-core: ^4.3
- symfony/security-csrf: ^4.3
- symfony/security-guard: ^4.3
- symfony/translation: ^4.3
- symfony/validator: ^4.3
- symfony/web-link: ^4.3
- symfony/yaml: ^4.3
- twig/cssinliner-extension: ^2.0
- twig/twig: ^2.9
Requires (Dev)
- camelot/coding-style: ^2.0
- dama/doctrine-test-bundle: ^5.0
- doctrine/doctrine-fixtures-bundle: ^3.1
- friendsofphp/php-cs-fixer: ^2.15
- phpunit/phpunit: ^8.1
- psalm/plugin-phpunit: ^0.5.5
- symfony/browser-kit: ^4.3
- symfony/framework-bundle: ^4.3
- symfony/var-dumper: ^4.3
- symfony/webpack-encore-bundle: ^1.5
- vimeo/psalm: ^3.2
This package is auto-updated.
Last update: 2025-10-29 02:43:09 UTC
README
Requirements
- PHP 7.2+ with the following extensions:
intljsonpdo
- Composer 1.5+
- Yarn 1.10+
- NodeJS 10+
Installation
Option A — Site project (recommended)
Change to the base of where you want to create the new site install and run:
composer create-project maintainerati/bikeshed-skeleton my-bikeshed-site
Option B — Symfony Bundle (existing project)
From the project root, run:
composer require maintainerati/bikeshed-bundle
Option C — Standalone library (existing project)
From the project root, run:
composer require maintainerati/bikeshed
Configuration
Routes
NOTE: If you are not using the skeleton or the bundle the routes are automatically configured.
You need to configure the following named routes:
| Property | Value |
|---|---|
| Route Name | bikeshed_homepage |
| Path | / |
| Path Regex | #^/$#sDu |
| Host | ANY |
| Host Regex | |
| Scheme | ANY |
| Method | ANY |
| Requirements | NO CUSTOM |
| Class | Symfony\Component\Routing\Route |
| Defaults | _controller: Maintainerati\Bikeshed\Controller\HomepageController |
| Options | compiler_class: Symfony\Component\Routing\RouteCompiler |
| utf8: true |
| Property | Value |
|---|---|
| Route Name | bikeshed_focus |
| Path | /focus |
| Path Regex | #^/focus$#sDu |
| Host | ANY |
| Host Regex | |
| Scheme | ANY |
| Method | ANY |
| Requirements | NO CUSTOM |
| Class | Symfony\Component\Routing\Route |
| Defaults | _controller: Maintainerati\Bikeshed\Controller\FocusController |
| Options | compiler_class: Symfony\Component\Routing\RouteCompiler |
| utf8: true |
| Property | Value |
|---|---|
| Route Name | bikeshed_refocus |
| Path | /refocus/{event}/{session}/{space} |
| Path Regex | #^/refocus/(?P\w{8}-\w{4}-\w{4}-\w{4}-\w{12})/(?P\w{8}-\w{4}-\w{4}-\w{4}-\w{12})/(?P\w{8}-\w{4}-\w{4}-\w{4}-\w{12})$#sDu |
| Host | ANY |
| Host Regex | |
| Scheme | ANY |
| Method | ANY |
| Requirements | event: \w{8}-\w{4}-\w{4}-\w{4}-\w{12} |
| session: \w{8}-\w{4}-\w{4}-\w{4}-\w{12} | |
| space: \w{8}-\w{4}-\w{4}-\w{4}-\w{12} | |
| Class | Symfony\Component\Routing\Route |
| Defaults | _controller: Maintainerati\Bikeshed\Controller\ReFocusController |
| Options | compiler_class: Symfony\Component\Routing\RouteCompiler |
| utf8: true |
| Property | Value |
|---|---|
| Route Name | bikeshed_register |
| Path | /register |
| Path Regex | #^/register$#sDu |
| Host | ANY |
| Host Regex | |
| Scheme | ANY |
| Method | ANY |
| Requirements | NO CUSTOM |
| Class | Symfony\Component\Routing\Route |
| Defaults | _controller: Maintainerati\Bikeshed\Controller\RegistrationController |
| Options | compiler_class: Symfony\Component\Routing\RouteCompiler |
| utf8: true |
| Property | Value |
|---|---|
| Route Name | bikeshed_login |
| Path | /login |
| Path Regex | #^/login$#sDu |
| Host | ANY |
| Host Regex | |
| Scheme | ANY |
| Method | ANY |
| Requirements | NO CUSTOM |
| Class | Symfony\Component\Routing\Route |
| Defaults | _controller: Maintainerati\Bikeshed\Controller\SecurityController |
| Options | compiler_class: Symfony\Component\Routing\RouteCompiler |
| utf8: true |
| Property | Value |
|---|---|
| Route Name | bikeshed_logout |
| Path | /logout |
| Path Regex | #^/logout$#sDu |
| Host | ANY |
| Host Regex | |
| Scheme | ANY |
| Method | ANY |
| Requirements | NO CUSTOM |
| Class | Symfony\Component\Routing\Route |
| Defaults | NONE |
| Options | compiler_class: Symfony\Component\Routing\RouteCompiler |
| utf8: true |
| Property | Value |
|---|---|
| Route Name | bikeshed_admin_editor |
| Path | /admin/edit/{type}/{id} |
| Path Regex | #^/admin/edit/(?P(?:event |
| Host | ANY |
| Host Regex | |
| Scheme | ANY |
| Method | ANY |
| Requirements | id: \w{8}-\w{4}-\w{4}-\w{4}-\w{12} |
| type: (event | |
| Class | Symfony\Component\Routing\Route |
| Defaults | _controller: Maintainerati\Bikeshed\Controller\Admin\EditorController |
| Options | compiler_class: Symfony\Component\Routing\RouteCompiler |
| utf8: true |
| Property | Value |
|---|---|
| Route Name | bikeshed_admin_one_time_keys |
| Path | /admin/one-time-keys |
| Path Regex | #^/admin/one-time-keys$#sDu |
| Host | ANY |
| Host Regex | |
| Scheme | ANY |
| Method | ANY |
| Requirements | NO CUSTOM |
| Class | Symfony\Component\Routing\Route |
| Defaults | _controller: Maintainerati\Bikeshed\Controller\Admin\OneTimeKeysController |
| Options | compiler_class: Symfony\Component\Routing\RouteCompiler |
| utf8: true |
| Property | Value |
|---|---|
| Route Name | bikeshed_async_form |
| Path | /async/form/{event}/{session}/{space}/{note} |
| Path Regex | #^/async/form(?:/(?P\w{8}-\w{4}-\w{4}-\w{4}-\w{12})(?:/(?P\w{8}-\w{4}-\w{4}-\w{4}-\w{12})(?:/(?P\w{8}-\w{4}-\w{4}-\w{4}-\w{12})(?:/(?P\w{8}-\w{4}-\w{4}-\w{4}-\w{12}))?)?)?)?$#sDu |
| Host | ANY |
| Host Regex | |
| Scheme | ANY |
| Method | ANY |
| Requirements | event: \w{8}-\w{4}-\w{4}-\w{4}-\w{12} |
| note: \w{8}-\w{4}-\w{4}-\w{4}-\w{12} | |
| session: \w{8}-\w{4}-\w{4}-\w{4}-\w{12} | |
| space: \w{8}-\w{4}-\w{4}-\w{4}-\w{12} | |
| Class | Symfony\Component\Routing\Route |
| Defaults | _controller: Maintainerati\Bikeshed\Controller\AsyncFormController |
| _format: json | |
| event: NULL | |
| note: NULL | |
| session: NULL | |
| space: NULL | |
| Options | compiler_class: Symfony\Component\Routing\RouteCompiler |
| utf8: true |
| Property | Value |
|---|---|
| Route Name | bikeshed_space |
| Path | /space |
| Path Regex | #^/space$#sDu |
| Host | ANY |
| Host Regex | |
| Scheme | ANY |
| Method | ANY |
| Requirements | NO CUSTOM |
| Class | Symfony\Component\Routing\Route |
| Defaults | _controller: Maintainerati\Bikeshed\Controller\SpaceController |
| Options | compiler_class: Symfony\Component\Routing\RouteCompiler |
| utf8: true |
| Property | Value |
|---|---|
| Route Name | bikeshed_note |
| Path | /note/{id} |
| Path Regex | #^/note/(?P\w{8}-\w{4}-\w{4}-\w{4}-\w{12})$#sDu |
| Host | ANY |
| Host Regex | |
| Scheme | ANY |
| Method | ANY |
| Requirements | id: \w{8}-\w{4}-\w{4}-\w{4}-\w{12} |
| Class | Symfony\Component\Routing\Route |
| Defaults | _controller: Maintainerati\Bikeshed\Controller\NoteController |
| Options | compiler_class: Symfony\Component\Routing\RouteCompiler |
| utf8: true |