README.md
# Brocooly Framework - is it just another WordPress site?
[](https://github.com/czernika/brocooly/blob/master/LICENSE) [](https://gitHub.com/AliakseynkaIhar/marusia/releases/)   [](https://bettercodehub.com/) [](https://www.codacy.com/gh/czernika/brocooly/dashboard?utm_source=github.com&utm_medium=referral&utm_content=czernika/brocooly&utm_campaign=Badge_Grade) [](https://codeclimate.com/github/czernika/brocooly/maintainability) [](https://codeclimate.com/github/czernika/brocooly/test_coverage) 
WordPress starter boilerplate with an improved folder structure (by [Bedrock](https://roots.io/bedrock)), twig template engine and webpack for compiling assets. It uses the power of [wepback](https://webpackjs.org) and [Timber](https://timber.github.io/docs/) together to simplify your local development workflow.
## Still Beta
> This package is on development mode
## Requirements
1. [Composer](https://getcomposer.org/)
2. PHP version 8.0 or greater
3. [Node.js](https://nodejs.org/)
## Getting Started
1 - Create a new project with
```sh
composer create-project czernika/brocooly your-app-folder
```
2 - Set your own environment variables in `.env` file
3 - Make sure the `DocumentRoot` is set to the `web` folder
See [here](https://roots.io/docs/bedrock/master/server-configuration/#nginx-configuration-for-bedrock).
4 - Install your project dependencies
```sh
npm install
```
5 - Now you can run
```sh
npm run watch
```
It will start watching your application at `http://localhost:3000`. First time this will trigger WordPress installation process
## Documentation
See [here](https://czernika.gitbook.io/brocooly/). **Work in progress**
## Known Issues
1. During installation process you may see **WordPress database error: Table doesn't exist** error. It is appears as database is not set but you're already connected to it with `.env` file credentials.
2. Fatal error with `sqlite3` PHP module. No PHP downgrade allowed so the only option is to disable SQLite3 extension.
3. First time login by 'wp-admin' - may not redirect to admin-panel although successfully being authenticated. If login by 'wp-login.php' - no problem.
4. Errors within `functions.php` bypassing maintenance mode