consul/nairobi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation README files

Browse Source 
These files are essentially the same as our README files, only our
README files contain information that only makes sense in the context
of a repository.
This commit is contained in:
Javi Martín
2024-06-18 23:01:56 +02:00
parent 0b9be27c8c
commit 777781f361
2 changed files with 9 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/en/README.md
View File

@@ -12,18 +12,13 @@ You can access the main website of the project at [http://consuldemocracy.org](h
**NOTE**: For more detailed instructions check the [docs](https://docs.consuldemocracy.org) **NOTE**: For more detailed instructions check the [docs](https://docs.consuldemocracy.org)
Prerequisites: install git, Ruby 3.0.6, CMake, pkg-config, shared-mime-info, Node.js and PostgreSQL (>=9.5). Prerequisites: install git, Ruby 3.2.4, CMake, pkg-config, shared-mime-info, Node.js 18.20.3 and PostgreSQL (>=9.5).
```bash ```bash
git clone https://github.com/consuldemocracy/consuldemocracy.git git clone https://github.com/consuldemocracy/consuldemocracy.git
cd consuldemocracy cd consuldemocracy
bundle install bin/setup
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml
bin/rake db:create
bin/rake db:migrate
bin/rake db:dev_seed bin/rake db:dev_seed
RAILS_ENV=test rake db:setup
``` ```
Run the app locally: Run the app locally:
@@ -32,12 +27,14 @@ Run the app locally:
bin/rails s bin/rails s
``` ```
Run the tests with: You can run the tests with:
```bash ```bash
bin/rspec bin/rspec
``` ```
Note: running the whole test suite on your machine might take more than an hour, so it's strongly recommended that you setup a Continuous Integration system in order to run them using parallel jobs every time you open or modify a pull request (if you use GitHub Actions or GitLab CI, this is already configured in `.github/workflows/tests.yml` and `.gitlab-ci.yml`) and only run tests related to your current task while developing on your machine. When you configure the application for the first time, it's recommended that you run at least one test in `spec/models/` and one test in `spec/system/` to check your machine is properly configured to run the tests.
You can use the default admin user from the seeds file: You can use the default admin user from the seeds file:
**user:** admin@consul.dev **user:** admin@consul.dev

11
docs/es/README.md
View File

@@ -12,18 +12,13 @@ Puedes acceder a la página principal del proyecto en [http://consuldemocracy.or
**NOTA**: para unas instrucciones más detalladas consulta la [documentación](https://docs.consuldemocracy.org) **NOTA**: para unas instrucciones más detalladas consulta la [documentación](https://docs.consuldemocracy.org)
Prerequisitos: tener instalado git, Ruby 3.0.6, CMake, pkg-config, shared-mime-info, Node.js y PostgreSQL (9.5 o superior). Prerequisitos: tener instalado git, Ruby 3.2.4, CMake, pkg-config, shared-mime-info, Node.js 18.20.3 y PostgreSQL (9.5 o superior).
```bash ```bash
git clone https://github.com/consuldemocracy/consuldemocracy.git git clone https://github.com/consuldemocracy/consuldemocracy.git
cd consuldemocracy cd consuldemocracy
bundle install bin/setup
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml
bin/rake db:create
bin/rake db:migrate
bin/rake db:dev_seed bin/rake db:dev_seed
RAILS_ENV=test rake db:setup
``` ```
Para ejecutar la aplicación en local: Para ejecutar la aplicación en local:
@@ -38,6 +33,8 @@ Para ejecutar los tests:
bin/rspec bin/rspec
``` ```
Nota: ejecutar todos los tests en tu máquina puede tardar más de una hora, por lo que recomendamos encarecidamente que configures un sistema de Integración Continua para ejecutarlos utilizando varios trabajos en paralelo cada vez que abras o modifiques una PR (si usas GitHub Actions o GitLab CI, esto ya está configurado en `.github/workflows/tests.yml` y `.gitlab-ci.yml`) y cuando trabajes en tu máquina ejecutes solamente los tests relacionados con tu desarrollo actual. Al configurar la aplicación por primera vez, recomendamos que ejecutes al menos un test en `spec/models/` y un test en `spec/system/` para comprobar que tu máquina está configurada para ejecutar los tests correctamente.
Puedes usar el usuario administrador por defecto del fichero seeds: Puedes usar el usuario administrador por defecto del fichero seeds:
**user:** admin@consul.dev **user:** admin@consul.dev