DEVELOPMENT.md

Development

Setup

First things first, you'll need to fork and clone the repository to your local machine.

git clone https://github.com/ecosyste-ms/issues.git

The project uses ruby on rails which have a number of system dependencies you'll need to install.

• ruby
• postgresql 14
• node.js 16+

You will then need to set some configuration environment variables. Copy env.example to .env.development and customise the values to suit your local setup.

Once you've got all of those installed, from the root directory of the project run the following commands:

bin/setup
bin/dev

You can then load up http://localhost:3000 to access the service.

Docker

Alternatively you can use the existing docker configuration files to run the app in a container.

Run this command from the root directory of the project to start the service.

docker-compose up --build

You can then load up http://localhost:3000 to access the service.

For access the rails console use the following command:

docker-compose exec app rails console

Runing rake tasks in docker follows a similar pattern:

docker-compose exec app rake gharchive:import_recent

Importing data

The default set of supported data sources are listed in db/seeds.rb and can be automatically enabled with the following rake command:

rake db:seed

You can then start importing recent GitHub data with the following commands:

rake hosts:sync_all            # Sync all hosts
rake gharchive:import_recent    # Import last 24 hours of GitHub data
rake repositories:sync_least_recent  # Sync repositories

Tests

The applications tests can be found in test and use the testing framework minitest.

You can run all the tests with:

rails test

Rake tasks

The applications rake tasks can be found in lib/tasks.

You can list all of the available rake tasks with the following command:

rake -T

Deployment

A container-based deployment is highly recommended, we use dokku.com.