First things first, you'll need to fork and clone the repository to your local machine.
git clone https://github.com/ecosyste-ms/funds.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:setup
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
The applications tests can be found in test and use the testing framework minitest.
You can run all the tests with:
rails test
Background tasks are handled by sidekiq, the workers live in app/sidekiq.
To process the tasks run the following command:
bundle exec sidekiq
You can also view the status of the workers and their queues from the web interface http://localhost:3000/sidekiq
A container-based deployment is highly recommended, we use dokku.com.
Required environment variables:
OPENCOLLECTIVE_TOKEN- A token for the Open Source Collective APIOPENCOLLECTIVE_PARENT_SLUG- The parent collective id for the Open Source Collective API (e.g.opensource)PROXY_PARENT_COLLECTIVE_SLUG- The parent collective slug for the proxy collectives (e.g.ecosystem-funds)