Skip to content

I'll add a GIF showing the use of BetterOCaml in Chromium #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 54 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
54 commits
Select commit Hold shift + click to select a range
519a806
second
jbdoderlein Jan 27, 2021
5c594e5
Create README.md
jbdoderlein Jan 27, 2021
acb5b53
add gitignore
jbdoderlein Jan 27, 2021
537e6d1
add gitignore
jbdoderlein Jan 27, 2021
bbabeef
Delete .idea directory
jbdoderlein Jan 27, 2021
f221e0e
major upgrade
jbdoderlein Jan 28, 2021
a6c8d9c
not autotcompletenow
jbdoderlein Jan 28, 2021
d56f214
commentaire + fichier
jbdoderlein Jan 29, 2021
52489f7
icon
jbdoderlein Jan 29, 2021
51483be
icon, css fixed
jbdoderlein Jan 29, 2021
8c7891e
correct bug and add new one
jbdoderlein Jan 30, 2021
97e9667
a stable version
jbdoderlein Jan 30, 2021
de7903d
leave feature
jbdoderlein Feb 1, 2021
43199c4
a nice save
jbdoderlein Feb 7, 2021
302596d
correct toast, add more toast, and github
jbdoderlein Feb 8, 2021
115da68
restructure et change theme
jbdoderlein Feb 8, 2021
6037c1a
web inutile
jbdoderlein Feb 8, 2021
487ada8
theme, cookie, materialize v 1.0
jbdoderlein Feb 8, 2021
133112d
theme made good
jbdoderlein Feb 9, 2021
4577e9a
Merge pull request #1 from jbdo99/uirework
jbdoderlein Feb 9, 2021
61fec2f
no more default
jbdoderlein Feb 9, 2021
3a00f1e
clean and new
jbdoderlein Feb 10, 2021
b018ca4
WIP
jbdoderlein Feb 12, 2021
d3bd332
w
jbdoderlein Feb 12, 2021
978b534
correct sub error
jbdoderlein Feb 12, 2021
55e531a
WIP : tabs avec js
jbdoderlein Feb 13, 2021
08d3aed
WIP presentation ok, add ok + bug a corriger
jbdoderlein Feb 14, 2021
d5bd0de
Create LICENSE
jbdoderlein Feb 14, 2021
94c54c5
Update README.md
jbdoderlein Feb 14, 2021
d43e018
Tab work !
jbdoderlein Feb 14, 2021
46545cd
Final : toutes fonction ajouté
jbdoderlein Feb 15, 2021
b555c98
correct firefox, add clear ocaml and save warning
jbdoderlein Feb 16, 2021
df9c6ff
Update README.md
jbdoderlein Feb 16, 2021
8afe0c8
Merge branch 'master' into dev
jbdoderlein Feb 16, 2021
837feb1
Merge pull request #5 from jbdo99/dev
jbdoderlein Feb 16, 2021
d78317a
Common gitignore
jbdoderlein Feb 20, 2021
3a6b376
Cache app + generator !
jbdoderlein Feb 20, 2021
12d7855
Add a section about using offline, and using WebCatalog
Naereen Feb 21, 2021
a0c7d31
Merge pull request #7 from Naereen/patch-1
jbdoderlein Feb 21, 2021
76e7ca2
Update README.md
Naereen Feb 25, 2021
be9a6ba
Merge pull request #11 from Naereen/patch-1
jbdoderlein Feb 25, 2021
66044f0
mobile correct
jbdoderlein Feb 25, 2021
cf865b4
Correct box and add button
jbdoderlein Feb 25, 2021
359be71
Manifest + vertical resizer
jbdoderlein Feb 27, 2021
a81af1f
Service worker
jbdoderlein Feb 27, 2021
7bf5007
Merge pull request #15 from jbdo99/jb-mobile
jbdoderlein Feb 27, 2021
af1d5a6
Correct url + delete useless files
jbdoderlein Feb 27, 2021
ec28d4f
File saved in text/x-ocaml
jbdoderlein Feb 27, 2021
6349e21
Almost done : height correction
jbdoderlein Feb 28, 2021
99fc194
Compromise : a new scroll bar
jbdoderlein Feb 28, 2021
3eade32
Update README.md
Naereen Feb 28, 2021
43ea514
Merge pull request #16 from Naereen/patch-2
jbdoderlein Feb 28, 2021
757db20
A small type ;)
jbdoderlein Feb 28, 2021
8536a16
I'll add a GIF showing the use of BetterOCaml in Chromium
Naereen Feb 28, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.idea

release/

node_modules/
out/
release-builds/
201 changes: 201 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
68 changes: 68 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# BetterOCaml
[![Website betterocaml.ml](https://img.shields.io/website-up-down-green-red/https/betterocaml.ml.svg)](https://betterocaml.ml/)
[![GitHub license](https://img.shields.io/github/license/jbdo99/betterocaml)](https://github.com/jbdo99/betterocaml/blob/master/LICENSE)
![Compatibility](https://img.shields.io/badge/browser-chrome--firefox--edge-green)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/jbdo99/BetterOCaml/graphs/commit-activity)

An efficient, intuitive and cross-platform web IDE for the [OCaml](https://www.ocaml.org/) language (recent: v4.08.1), with your code interpreted and running in your browser! (no server is needed!)

## Installation / Usage

The IDE is hosted [here](https://betterocaml/), <https://BetterOCaml.ml/>, but you can host your own version by simply copying the files from the `src/` directory on your host (on a folder of your laptop, or a folder of your web-server, see <http://ocaml.besson.link/> for an example).

It is a *purely static website*: once your browser downloads the files from the server (about 35 Mb), it will run the OCaml code in its javascript engine, without sending anything to a distant server!
Your data is secure, and this website does not use any third party service cookie :no_good_man: :cookie:.

Without installing any software on your laptop or smartphone, use [this web-based editor](https://BetterOCaml.ml/) to access to a complete OCaml REPL and text editor, with syntax highlighting, a full support of recent OCaml syntax and [the entire standard library](https://caml.inria.fr/pub/docs/manual-ocaml/libref/), and multiple-files that you can save to or load from your computer.
Note that there is only a partial support for [`Graphics`](https://github.com/ocaml/graphics/tree/master/examples) and it works better on Google Chrome or Chromum, no support for [`Unix*`](http://caml.inria.fr/pub/docs/manual-ocaml/libref/Unix.html) modules, and of course no [`Sys.command`](http://caml.inria.fr/pub/docs/manual-ocaml/libref/Sys.html#VALcommand) function.

## How to use ?

[![editor](https://user-images.githubusercontent.com/10222041/108104039-1204c680-708b-11eb-8054-58f7f9e5fe28.png)](https://BetterOCaml.ml/)

The editor is made of 4 parts, as seen in this screenshot:
- **1 Controls** : with these buttons you can add, execute, save and load code in the editor and access to settings;
- **2 Tabs** : this is where you can switch between multiple files;
- **3 Editor** : you can type code here and execute with `Ctrl+Enter`. Each OCaml statement must be finished with `;;`, and [toplevel directives](https://caml.inria.fr/pub/docs/manual-ocaml/toplevel.html#s%3Atoplevel-directives) are *not* supported;
- **4 Output & Console** : this the output of OCaml, showing values and messages printed to `sdtout`, you can also type command here (after the `# ` sign), which much ends with `;;` and type `Enter`.

### :art: Theme
You can choose the theme in the settings, in the top right corner. Your preference should be used the next time you come back on the editor.
There are currently three themes (two dark themes, "default" and "Monokai", and a light one, "MDN").

If you have any suggestion for a new theme, [open an issue](https://github.com/jbdo99/BetterOCaml/issues/new) :+1: !

## :sparkles: Use offline?
### :computer: On a laptop or desktop
- If you visit [the editor](https://BetterOCaml.ml/) webpage using your favorite browser, and if it works fine, you can add the link to your :star: "favorites", and then later on, if you open the direct link, it should work and load back BetterOCaml... even if your browser is offline!
- This can only work if you don't clean-up or delete the cache of your browser, but it should work even if you turn-off and turn-on again your laptop!

- We [recently](https://github.com/jbdo99/BetterOCaml/issues/12) [added](https://github.com/jbdo99/BetterOCaml/issues/13) support for an [app manifest](https://github.com/jbdo99/BetterOCaml/blob/master/src/manifest.json) and [service workers](https://github.com/jbdo99/BetterOCaml/blob/master/src/serviceWorker.js), so this web app is now a *Progressive Web App* (PWA), which can be installed on your laptop and used later on, even if you're offline! After being intalled, the app should appear in your global application menu (it works on Chromium on both Windows and Ubuntu).

> If you can't install it as a PWA, [@Naereen](https://github.com/Naereen) recommends trying [WebCatalog](https://webcatalog.app/), a multi-platform desktop app (for \*NIX, Windows and Mac OS), and you can then use it to "install" [the BetterOCaml editor](https://BetterOCaml.ml), along with its integrated OCaml interpreter (of course), as a "native" desktop app. It then appears in the menu of your system, and it works offline! See [this 1:30min tutorial in video](https://github.com/jbdo99/BetterOCaml/issues/6#issuecomment-780269129).

### :phone: On a smartphone
- It also works fine on smartphone running any recent OS and browser, :ok_hand: and the app should be "responsive" and switch to a vertical layout if your screen is too narrow.
- Loading the OCaml toplevel can take a few seconds on a mobile 3G/4G or :snail: slow Wifi networks: it's over 30 Mb, as it includes all of [OCaml standard library](https://caml.inria.fr/pub/docs/manual-ocaml/libref/)!
- The *Progressive Web App* can be installed on your smartphone: there should be a small + button near the address bar, or a "Install it" option in the menu. Once you install it, there should be an icon in the home screen (but not in the app menu) that launches the app in full size mode (like a browser, but no address bar). It [works fine](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Developer_guide/Installing#what_browsers_support_installation) on Chrom(e|ium) and Firefox mobile on Android, at least.
- If you think that this is not enough, and that the website should be bundled as a native iOS/Android app, please vote :+1: on [this issue](https://github.com/jbdo99/BetterOCaml/issues/14).

## About this project

### :hammer_and_wrench: Dependencies
BetterOCaml is made with these open-source tools:
- [js_of_ocaml](https://ocsigen.org/js_of_ocaml/3.7.0/manual/overview) v3.7.0 : compile the OCaml toplevel to javascript;
- [Materialize](https://materializecss.com/) : CSS and javascript framework;
- [Codemirror](https://codemirror.net/) : javascript code editor.

### Contributing?
Pull requests are welcome. For major changes, please [open an issue first](https://github.com/jbdo99/BetterOCaml/issues/new) to discuss what you would like to change.

### :sos: Need help?
If something is wrong or if you encounter any issue when using BetterOCaml, please [open an issue first](https://github.com/jbdo99/BetterOCaml/issues/new) (you have [to create a GitHub account](https://github.com/join) first).

### :scroll: License
This project is released publicly under the terms of the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license.

### Authors
This project was initiated and is maintained by [@jbdo99](https://github.com/jbdo99/), with help and contributions from a few [other people](https://github.com/jbdo99/BetterOCaml/graphs/contributors).
Loading