diff --git a/docs/en/getting_started/installation.md b/docs/en/getting_started/installation.md index a6a087610..1bfd72ee4 100644 --- a/docs/en/getting_started/installation.md +++ b/docs/en/getting_started/installation.md @@ -1,37 +1,47 @@ # Local installation -Before installing Consul and having it up and running make sure you have [Ruby 2.3.2](https://www.ruby-lang.org/en/news/2016/11/15/ruby-2-3-2-released/) installed in your local environment. +Before installing Consul and having it up and running make sure you all [prerequisites](prerequisites) installed. 1. First, clone the [Consul Github repository](https://github.com/consul/consul/): - ``` + ```bash git clone https://github.com/consul/consul.git ``` 2. Go to the project folder and install the gems stack using [Bundler](http://bundler.io/): - ``` + + ```bash cd consul bundle install ``` 3. Copy the environment example configuration files inside new readable ones: - ``` + ```bash cp config/database.yml.example config/database.yml cp config/secrets.yml.example config/secrets.yml ``` -4. Run the following [Rake tasks](https://github.com/ruby/rake) to fill your local database with the minimum data to run the application: + And setup database credentials with your `consul` user in your new `database.yml` file. - ``` +4. Run the following [Rake tasks](https://github.com/ruby/rake) to create and fill your local database with the minimum data to run the application: + + ```bash + bin/rake db:create bin/rake db:setup bin/rake db:dev_seed - RAILS_ENV=test rake db:setup + RAILS_ENV=test bin/rake db:setup ``` -5. Now you have all set, run the application: +5. Check everything is fine by running the test suite (beware it takes some long minutes): + ```bash + bundle exec rspec ``` + +6. Now you have all set, run the application: + + ```bash rails s ``` diff --git a/docs/es/getting_started/installation.md b/docs/es/getting_started/installation.md index 320b9debb..9fb5216c6 100644 --- a/docs/es/getting_started/installation.md +++ b/docs/es/getting_started/installation.md @@ -1,37 +1,47 @@ # Instalación local -Antes de instalar Consul y empezar a usarlo asegúrate de tener [Ruby 2.3.2](https://www.ruby-lang.org/en/news/2016/11/15/ruby-2-3-2-released/) instalado en tu entorno local. +Antes de comenzar a instalar Consul, comprueba que tengas todos los [prerrequisitos](prerequisites) correctamente instalados. 1. Primero, clona el [repositorio de Consul en Github](https://github.com/consul/consul/): - ``` + ```bash git clone https://github.com/consul/consul.git ``` 2. Ve a la carpeta del proyecto e instala las gemas requeridas usando [Bundler](http://bundler.io/): - ``` + + ```bash cd consul bundle install ``` 3. Copia los archivos de configuración de ejemplo del entorno dentro de unos nuevos válidos: - ``` + ```bash cp config/database.yml.example config/database.yml cp config/secrets.yml.example config/secrets.yml ``` -4. Ejecuta las siguientes [tareas Rake](https://github.com/ruby/rake) para rellenar tu base de datos local con el mínimo de información necesaria para que la aplicación funcione correctamente: + Y configura los de tu usuario de base de datos `consul` en `database.yml` - ``` +4. Ejecuta las siguientes [tareas Rake](https://github.com/ruby/rake) para crear y rellenar tu base de datos local con el mínimo de información necesaria para que la aplicación funcione correctamente: + + ```bash + bin/rake db:create bin/rake db:setup bin/rake db:dev_seed - RAILS_ENV=test rake db:setup + RAILS_ENV=test bin/rake db:setup ``` -5. Ahora que ya está todo listo puedes ejecutar la aplicación: +5. Comprueba que todo funciona correctamente lanzando la suite de tests (ten en cuenta que tardará unos cuantos minutos): + ```bash + bundle exec rspec ``` + +6. Ahora que ya está todo listo puedes ejecutar la aplicación: + + ```bash rails s ```