# Open Source Help Community

[![Build Status](https://travis-ci.org/OpenSourceHelpCommunity/OpenSourceHelpCommunity.github.io.svg?branch=predev)](https://travis-ci.org/OpenSourceHelpCommunity/OpenSourceHelpCommunity.github.io) [![Coverage Status](https://coveralls.io/repos/github/OpenSourceHelpCommunity/OpenSourceHelpCommunity.github.io/badge.svg?branch=predev)](https://coveralls.io/github/OpenSourceHelpCommunity/OpenSourceHelpCommunity.github.io?branch=predev)

![OSHC](https://avatars0.githubusercontent.com/u/23719480?v=3&s=200)

We are trying to create a medium where people who want to start with contributing to open sources and open source contributors meet and discuss their thoughts and questions([Getting Started With Open Source](https://github.com/tapasweni-pathak/Getting-Started-With-Contributing-to-Open-Sources)).

[Website](http://opensourcehelpcommunity.herokuapp.com/) [WIP]

## Deployement details

After every commit

1. The `predev` branch on GitHub is automatically deployed to [opensourcehelpcommunity-predev.herokuapp.com](http://opensourcehelpcommunity-predev.herokuapp.com/).
1. The `develop` branch on github is automatically deployed to [opensourcehelpcommunity-dev.herokuapp.com](http://opensourcehelpcommunity-dev.herokuapp.com/).
1. The `master` branch is automatically deployed [to opensourcehelpcommunity.herokuapp.com](http://opensourcehelpcommunity.herokuapp.com/) .

This is using [Django(1.11)](https://www.djangoproject.com/) and [Bootstrap](http://getbootstrap.com/)

## How to Contribute

This is an Open Source project and we would be happy to see contributors who report bugs and file feature requests submitting pull requests as well. This project adheres to the Collaborative [code of conduct](https://github.com/OpenSourceHelpCommunity/OpenSourceHelpCommunity.github.io/blob/develop/CODE_OF_CONDUCT.md). By participating, you expect to maintain the code of conduct. Before creating `New issue` and `Pull request`, please refer to the [template](docs).

All the development is done on `predev` branch and once we're ready for testing the deployment in real environment with databases we merge the `predev` branch with the `develop` branch. When we're ready for new release we merge `develop` with `master` to deploy it on our main website. **Please submit your pull request based on `predev` branch.**

## Installations

Run

```bash
pip install -r requirements.txt
```

to install everything required to run this project on heroku as well as on your local.

## To run this in your local

1. Clone this repository using

   ```bash
   git clone git@github.com:OpenSourceHelpCommunity/OpenSourceHelpCommunity.github.io.git
   ```

1. Go inside main Django app [Instructional video on installing Django](https://youtu.be/qgGIqRFvFFk)

   ```bash
   cd oshc
   ```

1. Install [pre-commit](http://pre-commit.com/) into your git hooks. [pre-commit](http://pre-commit.com/) will now run on every commit. Every time you clone a project that is using [pre-commit](http://pre-commit.com/) running [pre-commit](http://pre-commit.com/) install should always be the first thing you do after installing requirements.

   ```bash
   pre-commit install
   ```

1. Collectstatic files using

   ```bash
   python manage.py collectstatic
   ```

1. Run the app
   ```bash
   python manage.py runserver
   ```

To run the web app in Debug mode set the DEBUG environment variable.
In Linux, run the `export DEBUG=True` command in the terminal.

Feel free to raise and fix issues.
For any questions, join #oshc-dev on Slack. Get an invite [here](https://opensourcehelp.herokuapp.com/).

Note: All design related tasks have reward associated with them.