Skip to content

Commit

Permalink
Added MariaDB to database options. Minor README.md edits.
Browse files Browse the repository at this point in the history
Added MariaDB to database options. Minor README.md edits.
Added MariaDB to database options. Minor README.md edits.
  • Loading branch information
Nicholas committed Feb 10, 2018
1 parent 8024151 commit 3650407
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ http://www.wordpressify.co/
- [3. CSS, PostCSS and Sass](#3-css-postcss-and-sass)
- [PostCSS](#postcss)
- [Sass](#sass)
- [4. Fonts and Images](#4-fonts-and-images)
- [4. Images and Fonts](#4-images-and-fonts)
- [Images](#images)
- [Fonts](#fonts)
- [5. JavaScript ES6](#5-javascript-es6)
Expand All @@ -23,12 +23,12 @@ http://www.wordpressify.co/
- [8. Code Style Rules](#8-code-style-rules)
- [Lint CSS](#lint-css)
- [9. Database](#9-database)
- [MySQL Server](#mysql-server)
- [MySQL/MariaDB Server](#mysqlmariadb-server)
- [Remote Database](#remote-database)
- [Changelog](#changelog)
- [License](#license)

### Introduction
## Introduction
WordPressify is a modern workflow for your WordPress development, with an integrated web server and auto-reload. CSS preprocessors and ES6 ready.

## Features
Expand Down Expand Up @@ -95,18 +95,18 @@ npm run install:wordpress
npm run dev
```

- If you are running a fresh installation, you will have to set up the general information for the WordPress wizard (site name, description, database etc…).
- If you are running a fresh instance of WordPress, the installation wizard will set up a **wp-config.php** file containing database credentials, site name etc.
- You are ready to go! Happy coding!

**WORDPRESS PLUGINS**

- If you want to add or build WordPress plugins, you can do that from the directory:

```
src/plugins
src/plugins/
```

**PRODUCTION TEMPLETE**
**PRODUCTION TEMPLATE**

- To generate your distribution files run the command:

Expand All @@ -130,6 +130,8 @@ By default WordPressify supports [PostCSS](http://postcss.org/), a similar prepr

**POSTCSS PLUGINS**

WordPressify has two different sets of PostCSS plugins - one for the development environment (pluginsDev) and one for the production task (pluginsProd).

```javascript
//--------------------------------------------------------------------------------------------------
/* -------------------------------------------------------------------------------------------------
Expand All @@ -154,8 +156,6 @@ const pluginsProd = [
//--------------------------------------------------------------------------------------------------
```

The code above shows that we have two different sets of PostCSS plugins - one for the development environment (pluginsDev) and one for the production task (pluginsProd).

**WRITING CSS**

The starting point for CSS is the file:
Expand All @@ -179,7 +179,7 @@ Tags: responsive, clean, minimal, modern, documentation
```

## Sass
WordPressify is super flexible. You can install Sass and use it as a main CSS preprocessor:
WordPressify is super flexible. You can install Sass and use it as the main CSS preprocessor:

```
npm install gulp-sass --save-dev
Expand Down Expand Up @@ -227,17 +227,17 @@ gulp.task('watch', () => {
});
```

# 4. Fonts and Images
# 4. Images and Fonts
## Images
It is recommended to store template image assets in your theme directory:

```
src/theme/img/
```

Ideally all heavy bitmaps should be managed through the [Media Library](https://codex.wordpress.org/Media_Library_Screen) of WordPress. Try to only store SVG or minimal assets in your theme directory to keep the template as light as possible.
Ideally other images should be managed through the [Media Library](https://codex.wordpress.org/Media_Library_Screen) of WordPress. Try to only store SVG or minimal assets in your theme directory to keep the template as light as possible.

In the production build the bitmaps and SVGs will go through a **minification** process.
In the production build SVGs and other image assets will go through a **minification** process.

## Fonts
Fonts are always special. Your fonts should be stored in:
Expand Down Expand Up @@ -327,14 +327,14 @@ tools/IntelliJ.xml

## Lint CSS

Before pushing changes make sure you have clean and consistent CSS. Run [Stylelint](https://stylelint.io/) with the command:
Before pushing changes make sure you have clean and consistent CSS. Run [stylelint](https://stylelint.io/) with the command:
```
$ npm run lint:css
```

# 9. Database
## MySQL Server
After installing WordPressify you will still need a database to store WordPress content. The recommended solution is to install [MySQL](https://dev.mysql.com/downloads/mysql/) on your local machine ([installation instructions](https://dev.mysql.com/doc/refman/5.7/en/installing.html)).
## MySQL/MariaDB Server
After installing WordPressify you will still need a database to store WordPress content. The recommended solution is to install either [MySQL](https://dev.mysql.com/downloads/mysql/) ([installation instructions](https://dev.mysql.com/doc/refman/5.7/en/installing.html)) or [MariaDB](https://mariadb.com/downloads/mariadb-tx) ([installation instructions](https://mariadb.com/products/get-started)) on your local machine.

## Remote Database
You are free to use remote databases. Please note that this will affect the speed depending on the connection.
Expand Down

0 comments on commit 3650407

Please sign in to comment.