├── CONTRIBUTIONS.md ├── LICENSE └── README.md /CONTRIBUTIONS.md: -------------------------------------------------------------------------------- 1 | # Contribution Guidelines 🙂 2 | 3 | - When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. 4 | - Don't forget to get yourself assigned before starting to work to avoid any clashes & confusion. 5 | 6 | 7 | ## Pull Request Process 8 | * Ensure any install or build dependencies are removed before the end of the layer when doing a build. 9 | * Update the README.md with details of changes to the interface- this includes new environment variables, exposed ports, useful file locations and container parameters. 10 | * Only send your pull requests to the development branch where once we reach a stable point it will be merged with the master branch. 11 | * Associate each Pull Request with the required issue number. 12 | * Please provide relevant steps to use your codebase adding few extra lines of comments or commands to run would be helpful for others to follow along. 13 | 14 | ## Branch Policy 15 | - development: If you are making a contribution make sure to send your Pull Request to this branch. All developments goes in this branch. 16 | - master: After significant features/bug-fixes are accumulated in development branch we will merge it with the master branch. 17 | 18 | ## Contribution Practices 19 | - Please be respectful of others, do not indulge in unacceptable behaviour 20 | - If a person is working or has been assigned an issue and you want to work on it please ask him/her if he is working on it 21 | - We are happy to allow you to work on your issues, but in case of long period of inactivity the issue will be approved to another volunteer 22 | - If you report a bug please provide steps to reproduce the bug. 23 | - In case of changing the backend routes please submit an updated routes documentation for the same. 24 | - If there is an UI related change it would be great if you could attach a screenshot with the resultant changes so it is easier to review for the maintainers 25 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2020 CodeChef-VIT 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | ⭐️ APK Runner ⭐️ 3 |

4 | Website to run APKs online. 5 |
6 | 7 |
8 | 9 | 10 | --- 11 | [![DOCS](https://img.shields.io/badge/Documentation-see%20docs-green?style=flat-square&logo=appveyor)](INSERT_LINK_FOR_DOCS_HERE) 12 | [![UI ](https://img.shields.io/badge/User%20Interface-Link%20to%20UI-orange?style=flat-square&logo=appveyor)](INSERT_UI_LINK_HERE) 13 | 14 | 15 | ## Features 16 | - Upload APK 17 | - Run the APK on the website without downloading or doing anything extra 18 | - iOS users can open the APK on their phones through the website 19 | 20 | 21 | ## Instructions to run 22 | ``` 23 | $ git clone https://github.com/CodeChefVIT/APK-Runner 24 | $ cd APK-Runner 25 | $ live-server 26 | ``` 27 | 28 | ## Contributors 29 | - Contributor Name 30 | - Contributor Name 31 | 32 | 33 |

34 | What is Hacktoberfest 2020? 😎 35 |

36 | Hacktoberfest is the easiest way to get into open source! Hacktoberfest is a month long celebration of open source code presented by Digital Ocean. 37 | 38 | During the entire month of October 2020, all you have to do is contribute to any open source project with the hacktoberfest tag and open at least 4 pull requests which follow the [Hacktoberfest guidelines](https://hacktoberfest.digitalocean.com/hacktoberfest-update?updated). It can be any project mentioned below and you can contribute in any way possible. It can be a be a bug fix, optimisation, feature addition or even a documentation enhancement! 39 | 40 | If you’ve never contributed to open source before, this is the perfect time to get started because Hacktoberfest provides a large list of available contribution opportunities. 41 | 42 |

43 | How to get Started? 💥 44 |

45 | 46 | Click on the link to register yourself [here](https://hacktoberfest.digitalocean.com/). 47 | 48 | ## Why should you take part? 🙌 49 | - Chance to contribute to awesome open source projects 50 | - Engage with reputed communities 51 | - Free swags and T-Shirts from Digital Ocean 52 | - Chance to get a tree planted and make Earth greener 53 | 54 | ## CONTRIBUTING 55 | 56 | Please refer [CONTRIBUTIONS.md](./CONTRIBUTIONS.md) to check our policies and practices. 57 | 58 | We welcome first time contributors and open source enthusiasts. Check out our issues and if you are willing to start with something simple check issues marked with the good-first-issue tag. 59 | 60 | ## License 61 | [![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://badges.mit-license.org) 62 | 63 | If you liked this project, please leave a 🌟 64 | 65 |

66 | With :heart: by CodeChef-VIT 67 |

68 | 69 | --------------------------------------------------------------------------------