Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Jnchi authored Oct 31, 2019
1 parent 63813f8 commit 67152cc
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,34 +10,37 @@
- [License](#license)

## Install
Install Node using the most recently released installer then install Bower and Gulp globally.
Install Node using the most recently released installer then install Gulp globally.

Using the legacy Node installation has caused installation errors in the past, so it's recommended to use the most recent version.
```
npm install -g bower

```sh
npm install -g gulp
```

From the project root run:
```

```sh
npm install
```
The installation should end with the `postinstall` script defined in the `package.json` file that runs bower install from the same directory.
If the installation process errors be sure to run `bower install manually`.

## Usage

To serve the application locally simply run
```

```sh
gulp
```

The default task runs the project using a development environment.

To seed the database with an admin and initial user run
```

```sh
MONGO_SEED=true npm start
```
the CLI output will include there passwords. Be sure to run this only once unless you mean to overwrite the admin's password.

the CLI output will include the passwords. Be sure to run this only once unless you mean to overwrite the admin's password.

## Contribute

Expand Down

0 comments on commit 67152cc

Please sign in to comment.