-
Notifications
You must be signed in to change notification settings - Fork 63
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #173 from reliefsupports/v.0.2.1
v0.2.1
- Loading branch information
Showing
31 changed files
with
491 additions
and
144 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,31 @@ | ||
## Contributing to Relief Supports | ||
|
||
TODO | ||
Without the support of the community Relief Supports can never achieve its targets. To streamline the process of integrating different inputs from the large number of contributors, we have introduced the following guidelines to follow when opening PRs and reporting issues. | ||
|
||
### Community | ||
Developers can now initiate discussions through [Gitter](https://gitter.im/relief-supports/Lobby). Before starting to work on an issue, please go through the existing [issues](https://github.com/reliefsupports/reliefsupports.org/issues) and pull requests to make sure no one is working on the same issue at the time. | ||
|
||
### Task Selection | ||
If you can work on one of the [PRIORITY](https://github.com/reliefsupports/reliefsupports.org/labels/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](https://github.com/reliefsupports/reliefsupports.org/issues/new) an issue and do as same. | ||
|
||
See the [milestones](https://github.com/reliefsupports/reliefsupports.org/milestones) page for grasp some idea where the project heading. | ||
|
||
Even you can check the [wiki](https://github.com/reliefsupports/reliefsupports.org/wiki) also. | ||
|
||
### Pull requests | ||
To start contributing, simply fork the repository, commit and push your changes, and open a Pull Request. We keep `master` branch only for production release and the working branch is always is `dev`. The Pull Requests should **always** be opened against the `dev` branch. | ||
|
||
Before you open the Pull Request, please make sure you have checked the following task list. | ||
|
||
* Rebased against the latest fetch from the `upstream/dev` branch | ||
* Verified for non conflicts | ||
* Tested for functionality and regressions (preferably on the provided [Docker Test Setup](../docker/README.md) to make sure that there are no hidden dependencies to your change that would not be in the deployment) | ||
|
||
When opening the Pull Request, please follow the provided template and provide as many details as possible for other contributors to quickly come up to speed on your contribution. This will greatly improve the chances of the Pull Request being merged quickly. Furthermore, if the change in the Pull Request contains UI changes, please include screenshots of the changed UIs as well. | ||
|
||
### Issues | ||
We always welcome suggestions and any bug reports that the community can provide. To organize this input, a template is provided to better describe the issue context. | ||
|
||
Before you open an issue, please make sure that it is not reported already. If there are similar issues that do not cover your scenario, please mention them in the new issue so that a potential fix can include all similar scenarios in to one patch. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,3 +12,4 @@ npm-debug.log | |
.env | ||
composer.lock | ||
.DS_Store | ||
.scripts/deploy.sh |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
#!/bin/bash | ||
PUBLIC_KEY_PATH= | ||
USERNAME= | ||
ENV=dev | ||
if [ $ENV = "dev" ]; then | ||
HOST= | ||
else | ||
HOST= | ||
fi | ||
|
||
cd .. | ||
sftp -i ${PUBLIC_KEY_PATH} ${USERNAME}@${HOST} <<EOF | ||
pwd | ||
cd /var/www/public | ||
put *.* | ||
put -r app | ||
put -r config | ||
put -r database | ||
put -r public | ||
put -r resources | ||
put -r routes | ||
EOF | ||
|
||
ssh -i ${PUBLIC_KEY_PATH} ${USERNAME}@${HOST} <<EOF | ||
cd /var/www/public | ||
rm -rf vendor | ||
composer install | ||
EOF |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Docker Based Test Environment | ||
|
||
This is a simple Docker based test environment for the ReliefSupports web development. The setup consists of an Apache container with PHP and MariaDB container. The working directory is mounted to the Apache container inside `/var/www/html` folder. | ||
|
||
### Usage | ||
|
||
To test a particular change, simply run the following command in Bash. | ||
|
||
```bash | ||
bash test-deployment.sh up | ||
``` | ||
>In Windows the command to run is `docker-compose --file docker-compose.yml --project-name reliefsupportsorg build` followed by `docker-compose --file docker-compose.yml --project-name reliefsupportsorg up -d`. | ||
This command will start the two containers and expose the site through port `8080`. The required Docker images are downloaded from the [public Docker registry](https://hub.docker.com). | ||
|
||
Please allow several minutes (longer if a `compose update` was not done on the source already) to start the server. You can use `docker logs -f reliefsupportsorg_website_1` command to check the server logs. Wait until the line ` Command line: 'apache2 -D FOREGROUND'` appears. | ||
|
||
To access the page, navigate to [http://localhost:8080](http://localhost:8080). Any change you do on the source while the containers are running are instantly reflected on the server since it's mounted as a volume. | ||
|
||
> NOTE: To reiterate, since it's a writable volume mount, any change you do inside the container will be reflected back in the source as well. Be careful of what you do after `docker exec` inside the container. | ||
To stop the test deployment run the following command. | ||
|
||
```bash | ||
bash test-deployment.sh down | ||
``` | ||
|
||
> Please note currently, db migrations is WIP and will not function correctly. This will soon be fixed. |
Empty file.
Oops, something went wrong.