gritbox / gritbox
Gritbox is a pre-packaged Nette Framework project, basic configured structure for your application.
Installs: 191
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 6
Forks: 117
Language:JavaScript
Type:project
Requires
- php: >= 7.0
- guzzlehttp/guzzle: ^6.2
- nesbot/carbon: ^1.22
- nette/nette: ~2.4
- nextras/mail-panel: ^2.3
- nextras/orm: ^2.2
Requires (Dev)
- nette/tester: ~1.0
- dev-master
- v2.4.3
- v2.4.2
- v2.4.1
- v2.4.0
- v2.3.7
- v2.3.6
- v2.3.5
- v2.3.4
- v2.3.3
- v2.3.2
- v2.3.1
- v2.3.0
- v2.2.7
- v2.2.6
- v2.2.5
- v2.2.4
- v2.2.3
- v2.2.2
- v2.2.1
- v2.2.0
- v2.1.9
- v2.1.8
- v2.1.7
- v2.1.6
- v2.1.5
- v2.1.4
- v2.1.3
- v2.1.2
- v2.1.1
- v2.1.0
- v2.0.18
- v2.0.17
- v2.0.16
- v2.0.15
- v2.0.14
- v2.0.13
- v2.0.12
- v2.0.11
- v2.0.10
- v2.0.9
- v2.0.8
- v2.0.7
- v2.0.6
- v2.0.5
- v2.0.4
This package is not auto-updated.
Last update: 2021-02-13 20:30:02 UTC
README
Gritbox is a pre-packaged and pre-configured Nette Framework application that you can use as the skeleton for your new applications.
Goal is to create an application skeleton using best practices (ORM, DI, Services, Components) including base functionalities every app needs like user register/login/password reset etc.
It is based on these technologies:
- PHP
- Nette (PHP framework)
- Nextras\ORM (ORM)
- Bootstrap 4 alpha 6 (CSS framework)
- Webpack (CSS, JS compiling, bundling and minification)
- SCSS (CSS pre-processor)
- jQuery (Javasript framework)
- NPM (package manager)
Features
Basic user management
Because every app needs these:
- Admin area
- Login form
- Register form
- Reset password form (sends password reset e-mail)
- TODO: Adding/removing users from Admin area
and more:
- ACL (Access Control List) defined in config.neon and annotations
- Flashmessage UX (stay always visible)
- Modules (Front, Admin)
- Services: EmailService
- Development tools:
- Stack setup: vendor bundles, caching via hashed files
Installation
1. Create project based on Gritbox via Composer
The best way to install Gritbox is using Composer. If you don't have Composer yet, download it following the instructions. Then use command:
composer create-project gritbox/gritbox my-app
cd my-app
2. Install Node modules via NPM
After you have Gritbox downloaded by Composer, run
npm install
which will install all Node modules into node_modules
directory.
3. Import Database
Create MySQL database and import basic database structure from /database/database.sql
dump.
4. Set local configuration
Rename config.local.template.neon
to config.local.neon
and edit database credentials
5. Make some dirs writable
Make directories temp
and log
writable. Navigate your browser
to the www
directory and you will see a welcome page. PHP 5.4 allows
you run php -S localhost:8888 -t www
to start the web server and
then visit http://localhost:8888
in your browser.
It is CRITICAL that whole app
, log
and temp
directories are NOT accessible
directly via a web browser! See security warning.
Licenses
- Nette: New BSD License or GPL 2.0 or 3.0 (http://nette.org/license)
- Nextras\ORM: MIT License (https://github.com/nextras/orm/blob/master/license.md)
- jQuery: MIT License (https://jquery.org/license)
- Adminer: Apache License 2.0 or GPL 2 (http://www.adminer.org)
- Sandbox: The Unlicense (http://unlicense.org)
- NPM: The Artistic License 2.0 (https://docs.npmjs.com/policies/license)
- Bootstrap: MIT License (https://github.com/twbs/bootstrap/blob/master/LICENSE)