Skip to content

Commit

Permalink
- Add new section "Framework structure" in README.md file
Browse files Browse the repository at this point in the history
-   Update README.md "Console commands" section
  • Loading branch information
egarofalo committed Jul 27, 2021
1 parent 278a790 commit ba046ba
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 1 deletion.
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## [1.1.0] - 2021-07-27

### Added

- Add new functions in `theme:update` console command wich allows update all theme metadata
- Add new section **Framework structure** in `README.md` file

### Changed

- `theme:update` console command source code improvements
- Update `README.md` **Console commands** section
33 changes: 32 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,37 @@ Download the project from github or using the <code>git clone</code> command, an

Install [Composer](https://getcomposer.org/download/) on your computer and once installed run in the cli <code>composer create-project codevelopers/fullstack</code>. If you want to install the project in a different folder, specify the name of the destination folder <code>composer create-project codevelopers/fullstack dest</code>.

## Framework structure

```sh
fullstack/ # → Root folder
├── config/ # → Sensitive information here
│ ├── ComposerSetup.php # → Composer script
│ ├── env.dev.php # → Development or testing environment configuration file
│ ├── env.dist.php # → Production environment configuration file
│ ├── env.local.php # → Local environment configuration file
│ ├── env.php # → Environment configuration file
│ └── salts.php # → Wordpress Authentication unique keys and salts
├── console/ # → Useful and powerful console commands
│ ├── DatabaseCreate.php # → database:create console command
│ ├── DatabaseExport.php # → database:export console command
│ ├── DatabaseImport.php # → database:import console command
│ ├── HellowWorld.php # → hello-world console command
│ └── ThemeUpdate.php # → theme:update console command
├── database/ # → Database backup files
├── public/ # → Public folder
│ ├── content # → wp-content WordPress folder
│ ├── wp # → WordPress core files
│ ├── index.php # → WordPress front controller
│ └── wp-config.php # → WordPress configuration file
├── .gitignore # → Changelog file
├── CHANGELOG.md # → Changelog file
├── cli # → Run console commands in the CLI
├── composer.json # → Composer file
├── LICENSE # → License file
└── README.md # → This file
```

## Install plugins

Search Wordpress plugins in the repository [WordPress Packagist](https://wpackagist.org/) and then run (in the cli) into the project root <code>composer require wpackagist-plugin/plugin-name</code> to install the plugin wich you choosed. You can also install the plugins from the WordPress dashboard.
Expand Down Expand Up @@ -52,7 +83,7 @@ Fullstack comes with a command line console (cli), with three commands:
- <code>php cli database:create</code> to create the database in mysql server.
- <code>php cli database:export</code> to dump the database structure and data in a self contained sql file.
- <code>php cli database:import</code> to import the database structure and data in the last generated sql file.
- <code>php cli theme:update</code> to change themes name and folder.
- <code>php cli theme:update</code> to change themes metadata in the `style.css` theme stylesheet.

Remember that the cli command must be used only in the local or development environment, as it uses dev packages installed with composer.

Expand Down

0 comments on commit ba046ba

Please sign in to comment.