forked from shatgupt/runmycode.online
-
Notifications
You must be signed in to change notification settings - Fork 0
/
faq.html
158 lines (140 loc) · 9.98 KB
/
faq.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>FAQ</title>
<meta name="description" content="Frequently Asked Questions about RunMyCode Online">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/png" href="favicon.png">
<link rel="stylesheet" type="text/css" href="css/style.css">
<script>
window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date
ga('create', 'UA-100606537-1', 'auto')
ga('send', 'pageview')
</script>
<script async src='https://www.google-analytics.com/analytics.js'></script>
</head>
<body>
<div class="container">
<header class="grid grid--center">
<div class="grid-cell u-1of4">
<h2><a href="/">RunMyCode</a></h2>
</div>
<div class="grid-cell">
<div class="menu">
<ul id="top-menu" class="right">
<li><a href="dashboard.html" class="hide-if-no-user" id="user-name">Dashboard</a></li>
<li><a href="codesheet.html" class="hide-if-no-user">CodeSheet</a></li>
<li><a href="faq.html">FAQ</a></li>
</ul>
</div>
</div>
</header>
<main>
<h3 class="text-center">Frequently Asked Questions</h3>
<h4 id="why"><a href="#why">#</a> Why did you create this?</h4>
<p>RunMyCode Online has been primarily made for developers to quickly tinker with code. The aim is to enable users to test a piece of code directly from browser without installing anything.<br>
Some use cases include:
<ul>
<li>For developers - Maintain a repo of code snippets on GitHub and use RunMyCode to quickly run them from browser. Or maybe just run an <a href="https://github.com/TheAlgorithms/Python/blob/master/sorts/quick_sort_3partition.py">algorithm</a> you saw on GitHub.</li>
<li>For professors - <a href="https://github.com/blog/2376-how-to-grade-programming-assignments-on-github">Grading programming assignments</a> directly on GitHub in a browser.</li>
<li>For students - Reading, writing and even executing programming assignments all from GitHub in a browser without worrying about installing compilers or git. Maybe check out a <a href="https://github.com/leachim6/hello-world/blob/master/c/c.c">Hello world program in C</a>?</li>
<li>Quickly run a small piece of code online from a browser through <a href="codesheet.html">CodeSheet</a>.</li>
</ul>
</p>
<h4 id="api-use"><a href="#api-use">#</a> Can I use RunMyCode Online API in my own app?</h4>
<p>Yes, you can. But please do not use the RunMyCode Online hosted version in production or anything that can implode universe. It is not meant to be. Also, there are time and network restrictions in the hosted version. Since all code will be open source soon, I would suggest to host the service yourself if you are going to use this heavily and don't want any limits.</p>
<h4 id="auth"><a href="#auth">#</a> Why do I need to authenticate?</h4>
<p>RunMyCode Online is a free service by a single developer. To restrict abuse, a key is required to use it. Your key will be generated once you authenticate yourself using any of the auth providers on the home page. This service only needs access to name and email and once the key is generated, you can immediately revoke RunMyCode Online's access from the auth provider. <a href="#privacy-policy">Concerned about your data?</a></p>
<h4 id="key-use"><a href="#key-use">#</a> How is the key used?</h4>
<p>Your key is used to authenticate and meter your usage.</p>
<h4 id="limits"><a href="#limits">#</a> What are the limitations?</h4>
<ul>
<li>Code should be a standalone program in a single file.</li>
<li>5 seconds time limit for each run.</li>
<li>No internet access from code.</li>
</ul>
<h4 id="browser-ext"><a href="#browser-ext">#</a> What browser extensions are available?</h4>
<ul>
<li><a href="https://chrome.google.com/webstore/detail/runmycode-online/iidcnkpdmnopbbkdmneglbelcefgfohf">Google Chrome</a></li>
<li><a href="https://addons.mozilla.org/en-US/firefox/addon/runmycode-online">Mozilla Firefox</a></li>
<li>Opera - Use <a href="https://addons.opera.com/en/extensions/details/download-chrome-extension-9/">this Opera extension</a> to install the Chrome version.</li>
</ul>
<h4 id="config-ext"><a href="#config-ext">#</a> How do I configure the extension?</h4>
<p>You don't need to. On install, the extension will redirect to RunMyCode Online dashboard to auto-configure itself. If you are already authenticated, then you are done. Otherwise you will be prompted to authenticate following which extension will auto-configure itself.<br>
If you are still facing issues, follow this YouTube video: <a href="https://www.youtube.com/watch?v=EoE7d9cvVVY">Configuring RunMyCode Online Extension.</a></p>
<h4 id="supported-lang"><a href="#supported-lang">#</a> What languages are supported?</h4>
<ol>
<li>C (GCC 7.2)</li>
<li>C++ (GCC 7.2)</li>
<li>Java 8</li>
<li>Nodejs 6.10</li>
<li>Python 2.7</li>
<li>Python 3.6</li>
<li>Ruby 2.2</li>
<li>PHP 7</li>
<li>Go 1.7</li>
<li>Kotlin</li>
<li>Scala</li>
</ol>
<h4 id="supported-sites"><a href="#supported-sites">#</a> What websites are supported by the browser extensions?</h4>
<p>All the supported version control sites have support for running standalone code from view, edit and new file pages.</p>
<ol>
<li><a href="https://github.com/shatgupt/runmycode-test/blob/master/ruby.rb">GitHub</a></li>
<li><a href="https://gitlab.com/shatgupt/runmycode-test/blob/master/ruby.rb">GitLab</a></li>
<li><a href="https://bitbucket.org/shatgupt/runmycode-test/src/master/ruby.rb">BitBucket</a></li>
<li><a href="https://gist.github.com/shatgupt/b76ebbf67c6a38d0decb686ff230dd04">GitHub Gist</a></li>
<li><a href="https://gitlab.com/snippets/1664532">GitLab Snippets</a></li>
<li><a href="https://bitbucket.org/snippets/shatgupt/jykE9">Bitbucket Snippets</a></li>
<li><a href="https://gobyexample.com/hello-world">Go by Example</a></li>
<li><a href="http://xahlee.info/php/list_basics.html">Xahlee</a></li>
<li><a href="http://www.learntosolveit.com/ruby/forloop.html">Learn To Solve It</a></li>
<li><a href="https://www.tutorialspoint.com/python3/python_basic_syntax.htm">Tutorials Point</a></li>
</ol>
<h4 id="permissions"><a href="#permissions">#</a> What permissions are requested by the browser extensions?</h4>
<p>Starting with v2, RMCO extensions only ask permission for GitHub by default. All other websites are optional and can be allowed on demand. Check your URL/tool bar for a blue RMCO icon on supported sites.</p>
<ul>
<li>Optional permissions for the above supported websites to allow extension to run code directly from there.</li>
<li><i>runmycode.online</i> - To auto-configure the extension.</li>
<li><i>api.runmycode.online</i> - To compile and run code.</li>
<li><i>tabs</i> - For detecting url change and page loading complete for single page apps like GitHub, BitBucket.</li>
<li><i>storage</i> - To store API URL and Key as extension options.</li>
</ul>
<h4 id="privacy-policy"><a href="#privacy-policy">#</a> Privacy Policy OR How is my data used/stored?</h4>
<ul>
<li>Only your name and email are accessed from auth provider and stored.</li>
<li>Name and email are used just to associate with a key.</li>
<li>No mail will be sent to your email unless there is an abuse detected.</li>
<li>No code run is stored unless there is an abuse detected.</li>
<li>Some data might be collected by Google Analytics.</li>
<li>Any more concerns? Please email to <a href="mailto:[email protected]">[email protected]</a>.</li>
</ul>
<h4 id="logout"><a href="#logout">#</a> Will I be able to use RunMyCode Online after I logout?</h4>
<p>Yes. You can still use already configured browser extensions. Logout simply deletes data stored by RunMyCode Online website. You won't be able to use <a href="codesheet.html">CodeSheet</a> though. You will get the same key if you log back in.</p>
<h4 id="delete-account"><a href="#delete-account">#</a> How do I delete my account?</h4>
<p>To prevent possible abuse, currently there is no delete button on the site. Please email to <a href="mailto:[email protected]">[email protected]</a> with the email id you authenticated with. Apologies for this inconvenience.</p>
<h4 id="source"><a href="#source">#</a> Where is the source code?</h4>
<ul>
<li><a href="https://github.com/shatgupt/runmycode.online">RunMyCode Online Website</a></li>
<li><a href="https://github.com/shatgupt/runmycode-ext">RunMyCode Online Browser Extensions</a></li>
<li><a href="#">RunMyCode Online API</a> (soon)</li>
</ul>
<h4 id="contact"><a href="#contact">#</a> How do I contact you?</h4>
<p>Please email to <a href="mailto:[email protected]">[email protected]</a>.</p>
</main>
<footer>
<p>© <a target="_blank" href="https://github.com/shatgupt">Shatrughn Gupta</a></p>
</footer>
</div>
<script>
const $ = s => document.querySelector(s)
const $$ = s => document.querySelectorAll(s)
let user = localStorage.getItem('runmycode')
if (user) {
$('#user-name').textContent = JSON.parse(user).name || 'Dashboard'
Array.from($$('.hide-if-no-user')).forEach(el => el.classList.remove('hide-if-no-user'))
}
</script>
</body>
</html>