aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJon Moss <me@jonathanmoss.me>2017-08-18 11:31:19 -0400
committerJon Moss <me@jonathanmoss.me>2017-08-18 11:33:32 -0400
commit2ebb284ef5bf2c36bd8ba0a4524cab83810f12ab (patch)
tree3defa85b74b541ce9da43e78b7583acbf8e99587
parentc6fda1eaa2ed4a2385ffa87a29a6c28ce0ff6086 (diff)
downloadrails-2ebb284ef5bf2c36bd8ba0a4524cab83810f12ab.tar.gz
rails-2ebb284ef5bf2c36bd8ba0a4524cab83810f12ab.tar.bz2
rails-2ebb284ef5bf2c36bd8ba0a4524cab83810f12ab.zip
Add Yarn installation instructions for Active Storage
This is a requirement when working on the JS portions of ASt. Using npm instead of Yarn is a bad idea here since the lockfile is in Yarn's format. [ci skip]
-rw-r--r--guides/source/development_dependencies_install.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/guides/source/development_dependencies_install.md b/guides/source/development_dependencies_install.md
index c57efd6362..73d6721d3c 100644
--- a/guides/source/development_dependencies_install.md
+++ b/guides/source/development_dependencies_install.md
@@ -335,3 +335,43 @@ FreeBSD users will have to run the following:
```bash
# portmaster databases/redis
```
+
+### Active Storage Setup
+
+When working on Active Storage, it is important to note that you need to
+install its JavaScript dependencies while working on that section of the
+codebase. In order to install these dependencies, it is necessary to
+have Yarn, a Node.js package manager, available on your system. A
+prerequisite for installing this package manager is that
+[Node.js](https://nodejs.org) is installed.
+
+
+On OSX, you can run:
+
+```bash
+brew install yarn
+```
+
+On Ubuntu, you can run:
+
+```bash
+curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
+echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
+
+sudo apt-get update && sudo apt-get install yarn
+```
+
+On Fedora or CentOS, just run:
+
+``bash
+sudo wget https://dl.yarnpkg.com/rpm/yarn.repo -O /etc/yum.repos.d/yarn.repo
+
+sudo yum install yarn
+```
+
+Finally, after installing Yarn, you will need to run the following
+command inside of the `activestorage` directory to install the dependencies:
+
+```bash
+yarn install
+```