https://github.com/jonasraoni/nines
https://github.com/jonasraoni/nines
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jonasraoni/nines
- Owner: jonasraoni
- License: gpl-2.0
- Created: 2022-11-11T11:59:06.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-03T10:09:15.000Z (about 3 years ago)
- Last Synced: 2025-07-08T07:17:35.461Z (6 months ago)
- Language: PHP
- Size: 1.5 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Installation
============
Make sure Composer is installed globally, as explained in the
[installation chapter][composer] of the Composer documentation.
Applications that use Symfony Flex
----------------------------------
Open a command console, enter your project directory and execute:
```console
$ composer require ubermichael/nines:4.x-dev-up
```
Applications that don't use Symfony Flex
----------------------------------------
### Step 1: Download the Bundles
Open a command console, enter your project directory and execute the
following command to download the latest stable version of this bundle:
```console
$ composer require ubermichael/nines:4.x-dev-up
```
### Step 2: Enable the Bundles You Want
Then, enable the bundle by adding it to the list of registered bundles
in the `config/bundles.php` file of your project:
```php
// config/bundles.php
return [
// ...
Nines\BlogBundle\NinesBlogBundle::class => ['all' => true],
Nines\DublinCoreBundle\NinesDublinCoreBundle::class => ['all' => true],
Nines\EditorBundle\NinesEditorBundle::class => ['all' => true],
Nines\FeedbackBundle\NinesFeedbackBundle::class => ['all' => true],
Nines\MakerBundle\NinesMakerBundle::class => ['dev' => true],
Nines\MediaBundle\NinesMediaBundle::class => ['all' => true],
Nines\SolrBundle\NinesSolrBundle::class => ['all' => true],
Nines\UserBundle\NinesUserBundle::class => ['all' => true],
Nines\UtilBundle\NinesUtilBundle::class => ['all' => true],
];
```
NinesUtilBundle is required by all the others.
### Step 3: Add Routing Information
Import the routing information as required:
```yaml
# config/routes.yaml
nines_blog:
resource: '@NinesBlogBundle/config/routes.yaml'
prefix: blog
nines_dublin_core:
resource: '@NinesDublinCoreBundle/config/routes.yaml'
prefix: dc
nines_editor:
resource: '@NinesEditorBundle/config/routes.yaml'
prefix: editor
nines_feedback:
resource: '@NinesFeedbackBundle/config/routes.yaml'
prefix: feedback
nines_media:
resource: '@NinesMediaBundle/config/routes.yaml'
prefix: media
nines_user:
resource: '@NinesUserBundle/config/routes.yaml'
```
### Step 4: Configure the Bundles
Copy the configuration files from the bundles and edit them as required:
```console
$ cp vendor/ubermichael/nines/*/config/nines_*.yaml config/packages/
```
### Step 5: Update Your Database Schema
How you do this one depends on your project and your config. [Doctrine
migrations][migrations] are the recommended approach.
### Post Installation
This should be enough to get the bundles working. You may also wish to load the
[Doctrine fixtures][fixtures].
Fixtures are available for development, testing, and production. They are
labelled `dev`, `test`, and `prod`.
```console
$ ./bin/console doctrine:fixtures:load --group=dev
```
Included Bundles
----------------
* [BlogBundle](BlogBundle/doc/index.md) - various blogging functionality
* [DublinCoreBundle](DublinCoreBundle/doc/index.md) - Attaches [Dublin Core Metadata][dcmi] to entities
* [EditorBundle](EditorBundle/doc/index.md) - Wrapper around CKEditor
* [FeedbackBundle](FeedbackBundle/doc/index.md) - Attach comments to entities
* [MediaBundle](MediaBundle/doc/index.md) - Upload media files and attach them to entities
* [SolrBundle](SolrBundle/doc/index.md) - Solr server client
* [UserBundle](UserBundle/doc/index.md) - User logins and security related things
* [UtilBundle](UtilBundle/doc/index.md) - Various things that don't fit well elsewhere
Each bundle should include documentation.
[composer]: https://getcomposer.org/doc/00-intro.md
[dcmi]: https://www.dublincore.org/specifications/dublin-core/dcmi-terms/
[migrations]: https://symfony.com/bundles/DoctrineMigrationsBundle/current/index.html
[fixtures]: https://symfony.com/bundles/DoctrineFixturesBundle/current/index.html