Relief Supports Project
This is a community-driven Open Source project to support relief support activities conducted by volunteers. This project was originally created to support flood relief activities in Sri Lanka in May 2017.
We welcome your innovative ideas and suggestions to make a better solution for the community.
How to Contribute
Developers can now initiate discussions through Gitter. Before starting to work on an issue, please go through the existing issues and pull requests to make sure no one is working on the same issue at the time.
If you can work on one of the PRIORITY issues it’ll be great the given the circumstance, but feel free to work on anything you want.
Once you select a task to work on, please mention that in the issue and apply the In Progress label for it. If it's a new issue, please create an issue and do as same.
See the milestones page for grasp some idea where the project heading.
Even you can check the wiki also.
Setting up the development environment
Generally speaking, you should fork this repository, make changes in your own fork, and then submit a pull-request. Please include necessary information with pull-request
Before send the pull-request, please make sure nothing has broken in the app with the new changes you made.
Pull requests
We keep master branch only for production release and the working branch is always is dev. So please create your pull-requests against dev branch and make sure to resolve the conflicts or rebase with dev.
There is an intermediate branch as staging for the UAT.
Setting up the development environment
On the project directory;
- Rename
.env.examplefile as.env - Update necessary configuration settings on the
.env
If you wish to use Docker please skip following steps and directly go to this section.
- You need to install composer and laravel first. See the laravel installation guide
- Change to the project directory
- Run following commands accordingly
composer install
// for Mac/Linux
chmod -R 777 storage/
chmod 777 bootstrap/cacheDocker
- You need to install Docker on your computer first.
- If Docker is running on your computer without any errors, follow the Docker Testing Guide.
License
MIT