Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include directions in README for setting up postgres to allow local unit testing. #183

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,28 @@ You can now login using the aforementioned default login data or the admin setti
}
```

#### 6. How to Contribute
`sails-permissions` requires an active postgres server to run unit tests against.

## Example Setup on Mac with Brew
1. Install `postgres` package. Follow directions provided by Brew to start
the server after installation.
```sh
$ brew install postgres
```
2. Create a user named `postgres`
```sh
$ createuser -s -r postgres
```
3. Login to `psql` with the user `postgres` to verify user creation
```sh
$ psql -U postgres
```
4. Exit `psql` and run unit tests like a boss!
```sh
$ npm test
```

## License
MIT

Expand Down