steve
/
mybuddy
mirror of https://github.com/snachodog/mybuddy.git
1
0
Fork 0
Code Issues 3 Packages Projects 1 Releases Wiki Activity

Add initial documentation for new gulp commands.

This commit is contained in:
Christopher Charbonneau Wells 2018-10-11 20:10:53 -07:00
parent 2b6fdf327f
commit ac39b241c3
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -594,6 +594,7 @@ in the [`babybuddy/management/commands`](babybuddy/management/commands) folder.
- [`gulp`](#gulp) - [`gulp`](#gulp)
- [`gulp build`](#build) - [`gulp build`](#build)
- [`gulp clear`](#clean)
- [`gulp collectstatic`](#collectstatic) - [`gulp collectstatic`](#collectstatic)
- [`gulp coverage`](#coverage) - [`gulp coverage`](#coverage)
- [`gulp extras`](#extras) - [`gulp extras`](#extras)
@ -601,6 +602,7 @@ in the [`babybuddy/management/commands`](babybuddy/management/commands) folder.
- [`gulp lint`](#lint) - [`gulp lint`](#lint)
- [`gulp makemigrations`](#makemigrations) - [`gulp makemigrations`](#makemigrations)
- [`gulp migrate`](#migrate) - [`gulp migrate`](#migrate)
- [`gulp pre-commit`](#pre-commit)
- [`gulp reset`](#reset) - [`gulp reset`](#reset)
- [`gulp runserver`](#runserver) - [`gulp runserver`](#runserver)
- [`gulp scripts`](#scripts) - [`gulp scripts`](#scripts)
@ -616,6 +618,12 @@ Executes the `build` and `watch` commands and runs Django's development server.
Creates all script, style and "extra" assets and places them in the Creates all script, style and "extra" assets and places them in the
`babybuddy/static` folder. `babybuddy/static` folder.
#### `clean`
Deletes all build folders and the root `static` folder. Generally this should
be run before a `gulp build` to remove previous build files and the generated
static assets.
#### `collectstatic` #### `collectstatic`
Executes Django's `collectstatic` management task. This task relies on files in Executes Django's `collectstatic` management task. This task relies on files in
@ -655,6 +663,12 @@ Executes Django's `migrate` management task. In addition to migrating the
database, this command creates the default `admin` user. Gulp also passes along database, this command creates the default `admin` user. Gulp also passes along
non-overlapping arguments for this command. non-overlapping arguments for this command.
#### `pre-commit`
Executes the gulp commands `lint`, `test`, `clear`, `build`, and
`collectstatic` in a series. This command should be executed before any commit,
preferably in a pre-commit hook.
#### `reset` #### `reset`
Resets the database to a default state *with* one fake child and 31 days of Resets the database to a default state *with* one fake child and 31 days of