First things first, you'll need to fork and clone the repository to your local machine.
git clone https://github.com/ecosyste-ms/docker.git
The project uses ruby on rails which have a number of system dependencies you'll need to install.
Once you've got all of those installed, from the root directory of the project run the following commands:
bundle install
bundle exec rake db:create
bundle exec rake db:migrate
rails server
You can then load up http://localhost:3000 to access the service.
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 docker:sync
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 syncing data for each source with the following command, this may take a while:
rake packages:sync
The applications tests can be found in test and use the testing framework minitest.
You can run all the tests with:
rails test
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
A container-based deployment is highly recommended, we use dokku.com.