pomuzeme.si
An open-source platform which aims to simplify and streamline the coordination of volunteers. Through the platform, local organizations can reach volunteers in the area where assistance is needed. This project originated as a voluntary initiative in connection with the COVID-19 infection.
Getting Started
The application is an MVC monolith written in the RubyOnRails framework. On Frontend we are using common "bootstrap" based frameworks such as Bulma or Materialize design.
Local development environment
Required software
- Ruby 2.6.3
- NodeJS
- yarn (
sudo npm install -g yarn) - PostgreSQL
- PostGIS
- Redis
Steps to get it running
git clone git@github.com:Applifting/pomuzeme.si.git && cd pomuzeme.sibundle install- setup
RGeo rake db:createNote: avoiddb:setupas there is andb:createhook that is required, in order to have postgres extension.psql pomuzeme_si_development -c "CREATE EXTENSION postgis;"rake db:migrateyarn installrails server
Contribution
In case you decide to contribute to this project, we will be very happy and we appreciate your help. Feel free to:
- Check out open issues. Ideally, choose from the ones that are labeled as
ready for dev. If you are going to contribute code, read our contribution guide. - Assign your self to the selected issue
- Write estimate delivery time into issue comment (preferably with ping to @snopedom)
- Create a new branch from
masterwhere work will be done - After work is done please create new pull request into
master - Wait for review and PR approval (PR should be approved by 2 other developers, at least one from Applifting)
- After merge work is DONE! Thank you! :heart:
If you have any questions about development or issue description, feel free to ask the author of the issue in comments.
Deployment
At this moment application is deployed on Heroku cloud service. We have two environments, staging and production.
Deployment to staging - staging.pomuzemesi.cz
Staging deployment is realised by automatic deploy hook which is triggered when code into master is merged (pushed).
Deployment to production - www.pomuzemesi.cz
Production deployment is done by authorized developers from Applifting. Deploys are made regularly, each time new functionality is created. If you need to put something into production contact:
Dominik Snopek - Development coordinator - dominik.snopek@applifting.cz
Martin HanzΓk - DevOps - martin.hanzik@applifting.cz
License
This project is licensed under the MIT License - see the LICENSE file for details
Authors
Authors of this platform are awesome guys and girls from Applifting. We could not do it without our Contributors that are listed below. Thanks from the bottom of our hearts! :heart:
