Replace eslint-rails-ee with direct calls to eslint

[rails.git] / INSTALL.md

diff --git a/INSTALL.md b/INSTALL.md
index 0343629110c39f2e1ca128547483a64e0e9e5d69..b03c9751525eb23f75f7992215924b7858b277f2 100644 (file)
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -5,10 +5,10 @@ If you want to deploy the software for your own project, then see the notes at t
 
 You can install the software directly on your machine, which is the traditional and probably best-supported approach. However, there is an alternative which may be easier: Vagrant. This installs the software into a virtual machine, which makes it easier to get a consistent development environment and may avoid installation difficulties. For Vagrant instructions, see [VAGRANT.md](VAGRANT.md).
 
 
 You can install the software directly on your machine, which is the traditional and probably best-supported approach. However, there is an alternative which may be easier: Vagrant. This installs the software into a virtual machine, which makes it easier to get a consistent development environment and may avoid installation difficulties. For Vagrant instructions, see [VAGRANT.md](VAGRANT.md).
 

-These instructions are based on Ubuntu 12.04 LTS, which is the platform used by the OSMF servers.
+These instructions are based on Ubuntu 18.04 LTS, which is the platform used by the OSMF servers.

 The instructions also work, with only minor amendments, for all other current Ubuntu releases, Fedora and MacOSX
 
 The instructions also work, with only minor amendments, for all other current Ubuntu releases, Fedora and MacOSX
 

-We don't recommend attempting to develop or deploy this software on Windows. If you need to use Windows, then try developing this sofware using Ubuntu in a virtual machine, or use [Vagrant](VAGRANT.md).
+We don't recommend attempting to develop or deploy this software on Windows. If you need to use Windows, then try developing this software using Ubuntu in a virtual machine, or use [Vagrant](VAGRANT.md).

 
 ## Dependencies
 
 
 ## Dependencies
 


@@ -18,22 +18,21 @@ of packages required before you can get the various gems installed.
 
 ## Minimum requirements
 
 
 ## Minimum requirements
 

-* Ruby 2.0
-* RubyGems 1.3.1+
-* Postgres 8.3+
+* Ruby 2.5+
+* PostgreSQL 9.1+

 * ImageMagick
 * Bundler
 * Javascript Runtime
 
 * ImageMagick
 * Bundler
 * Javascript Runtime
 

-These can be installed on Ubuntu 14.04 or later with:
+These can be installed on Ubuntu 16.04 or later with:

 
 ```
 
 ```

-sudo apt-get install ruby2.0 libruby2.0 ruby2.0-dev \
+sudo apt-get install ruby2.5 libruby2.5 ruby2.5-dev \

                      libmagickwand-dev libxml2-dev libxslt1-dev nodejs \
                      libmagickwand-dev libxml2-dev libxslt1-dev nodejs \

-                     apache2 apache2-threaded-dev build-essential git-core \
+                     apache2 apache2-dev build-essential git-core \

                      postgresql postgresql-contrib libpq-dev postgresql-server-dev-all \
                      postgresql postgresql-contrib libpq-dev postgresql-server-dev-all \

-                     libsasl2-dev imagemagick
-sudo gem2.0 install bundler
+                     libsasl2-dev imagemagick libffi-dev
+sudo gem2.5 install bundler

 ```
 
 ### Alternative platforms
 ```
 
 ### Alternative platforms


@@ -43,21 +42,21 @@ sudo gem2.0 install bundler
 For Fedora, you can install the minimum requirements with:
 
 ```
 For Fedora, you can install the minimum requirements with:
 
 ```

-sudo yum install ruby ruby-devel rubygem-rdoc rubygem-bundler rubygems \
+sudo dnf install ruby ruby-devel rubygem-rdoc rubygem-bundler rubygems \

                  libxml2-devel js \
                  gcc gcc-c++ git \
                  postgresql postgresql-server postgresql-contrib postgresql-devel \
                  libxml2-devel js \
                  gcc gcc-c++ git \
                  postgresql postgresql-server postgresql-contrib postgresql-devel \

-                 perl-podlators ImageMagick
+                 perl-podlators ImageMagick libffi-devel nodejs-yarn

 ```
 
 ```
 

-If you didn't already have Postgres installed then create a Postgres instance and start the server:
+If you didn't already have PostgreSQL installed then create a PostgreSQL instance and start the server:

 
 ```
 sudo postgresql-setup initdb
 sudo systemctl start postgresql.service
 ```
 
 
 ```
 sudo postgresql-setup initdb
 sudo systemctl start postgresql.service
 ```
 

-Optionally set Postgres to start on boot:
+Optionally set PostgreSQL to start on boot:

 
 ```
 sudo systemctl enable postgresql.service
 
 ```
 sudo systemctl enable postgresql.service


@@ -67,10 +66,10 @@ sudo systemctl enable postgresql.service
 
 For MacOSX, you will need XCode installed from the Mac App Store; OS X 10.7 (Lion) or later; and some familiarity with Unix development via the Terminal.
 
 
 For MacOSX, you will need XCode installed from the Mac App Store; OS X 10.7 (Lion) or later; and some familiarity with Unix development via the Terminal.
 

-Installing Postgres:
+Installing PostgreSQL:

 
 

-* Install Postgres.app from http://postgresapp.com/
-* Add Postgres to your path, by editing your profile:
+* Install Postgres.app from https://postgresapp.com/
+* Add PostgreSQL to your path, by editing your profile:

 
 `nano ~/.profile`
 
 
 `nano ~/.profile`
 


@@ -80,10 +79,12 @@ and adding:
 
 Installing other dependencies:
 
 
 Installing other dependencies:
 

-* Install Homebrew from http://mxcl.github.io/homebrew/
-* Install the latest version of Ruby: brew install ruby
-* Install ImageMagick: brew install imagemagick
-* Install Bundler: gem install bundler
+* Install Homebrew from https://brew.sh/
+* Install the latest version of Ruby: `brew install ruby`
+* Install ImageMagick: `brew install imagemagick`
+* Install libxml2: `brew install libxml2 --with-xml2-config`
+* If you want to run the tests, you need `phantomjs` as well: `brew install phantomjs`
+* Install Bundler: `gem install bundler`

 
 Note that OS X does not have a /home directory by default, so if you are using the GPX functions, you will need to change the directories specified in config/application.yml.
 
 
 Note that OS X does not have a /home directory by default, so if you are using the GPX functions, you will need to change the directories specified in config/application.yml.
 


@@ -113,16 +114,14 @@ cd openstreetmap-website
 bundle install
 ```
 
 bundle install
 ```
 

-## Application setup
+## Node.js modules

 
 

-We need to create the `config/application.yml` file from the example template. This contains various configuration options.
+We use [Yarn](https://yarnpkg.com/) to manage the Node.js modules required for the project.

 
 ```
 
 ```

-cp config/example.application.yml config/application.yml
+bundle exec rake yarn:install

 ```
 
 ```
 

-You can customize your installation of The Rails Port by changing the values in `config/application.yml`
-

 ## Database setup
 
 The Rails Port uses three databases -  one for development, one for testing, and one for production. The database-specific configuration
 ## Database setup
 
 The Rails Port uses three databases -  one for development, one for testing, and one for production. The database-specific configuration


@@ -138,7 +137,7 @@ instructions below as appropriate.
 
 ### PostgreSQL account setup
 
 
 ### PostgreSQL account setup
 

-We need to create a PostgreSQL role (i.e. user account) for your current user, and it needs to be a superuser so that we can create more database.
+We need to create a PostgreSQL role (i.e. user account) for your current user, and it needs to be a superuser so that we can create more databases.

 
 ```
 sudo -u postgres -i
 
 ```
 sudo -u postgres -i


@@ -156,7 +155,7 @@ bundle exec rake db:create
 
 ### PostgreSQL Btree-gist Extension
 
 
 ### PostgreSQL Btree-gist Extension
 

-We need to load the btree-gist extension, which is needed for showing changesets on the history tab.
+We need to load the `btree-gist` extension, which is needed for showing changesets on the history tab.

 
 ```
 psql -d openstreetmap -c "CREATE EXTENSION btree_gist"
 
 ```
 psql -d openstreetmap -c "CREATE EXTENSION btree_gist"


@@ -164,7 +163,7 @@ psql -d openstreetmap -c "CREATE EXTENSION btree_gist"
 
 ### PostgreSQL Functions
 
 
 ### PostgreSQL Functions
 

-We need to install special functions into the postgresql databases, and these are provided by a library that needs compiling first.
+We need to install special functions into the PostgreSQL databases, and these are provided by a library that needs compiling first.

 
 ```
 cd db/functions
 
 ```
 cd db/functions