Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Jnchi committed Oct 31, 2019
1 parent 403880c commit 097788e
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions readme.md → README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,39 +10,42 @@
- [License](#license)

## Install
Install Node using the most recently released installer then install Bower and Gulp globally.
Install the [Node v10 LTS](https://nodejs.org/en/about/releases) [installer](https://nodejs.org/download/release/latest-v10.x) for 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

PRs accepted.

## License

GPL-3.0
[GPL-3.0](LICENSE)

0 comments on commit 097788e

Please sign in to comment.