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.

Sign up for GitHub

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

Add documentation for sharp installation (#272) and OS X specific instructions #274

Merged
merged 1 commit into from
Sep 7, 2017
Merged

Add documentation for sharp installation (#272) and OS X specific instructions #274

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,14 +324,19 @@ Please ensure your operating system has the following software installed:

* [Git][] - see [GitHub's tutorial][github-git] for installation

* [Sharp][] - we use this for image transformation (e.g. an avatar file upload needs resized)

* Mac (via [brew][]): `brew install homebrew/science/vips --with-webp --with-graphicsmagick` (as of [sharp][] v0.18.2 this is required)
* Ubuntu/Windows - should work out of the box

* [Node.js][node] (v8.x+) - use [nvm][] to install it on any OS

* After installing `nvm` you will need to run `nvm install node`
* We also recommend you install [yarn][], which is an alternative to [npm][]

* [MongoDB][] (v3.x+):

* Mac (via [brew][]): `brew install mongodb`
* Mac (via [brew][]): `brew install mongodb && brew services start mongo`
* Ubuntu:

```sh
Expand All @@ -343,7 +348,7 @@ Please ensure your operating system has the following software installed:

* [Redis][] (v4.x+):

* Mac (via [brew][]): `brew install redis`
* Mac (via [brew][]): `brew install redis && brew services start redis`
* Ubuntu:

```sh
Expand Down Expand Up @@ -373,6 +378,7 @@ yarn global add lad
```sh
lad new-project
cd new-project
cp .env.defaults .env
```

#### Development
Expand Down Expand Up @@ -516,6 +522,8 @@ If you are seeking permission to use these trademarks, then please [contact us](

[github-git]: https://help.github.com/articles/set-up-git/

[sharp]: http://sharp.dimens.io/en/stable/

[git]: https://git-scm.com/

[slack]: http://slack.crocodilejs.com/
Expand Down