Merge pull request #10 from martin-azpillaga/refactor-simplify-projec…

…t-setup

Refactor: Simplify project setup

.github/workflows/deploy.yml

@@ -0,0 +1,35 @@
+name: Deploy website to Pages
+
+on: push
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Build website
+        run: |
+          npm install
+          npm run generateParser
+          npm run compile
+          npm run test
+          npm run bundle
+          npm run packageWeb
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: 'web'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -2,3 +2,4 @@
 .gradle
 node_modules
 dist
+web

README.md

@@ -1,28 +1,30 @@
 # calc-monaco-editor
 
-This project is explained in the article [Writing a browser based editor using Monaco and ANTLR](https://tomassetti.me/writing-a-browser-based-editor-using-monaco-and-antlr/).
+This project is explained in the article [Writing a browser based editor using Monaco and ANTLR].
 
 A browser based editor for a simple DSL to perform calculations.
 
 It shows how to integrate ANTLR with monaco.
 
-![Calc Example](./doc/images/calc_example.png)
+![Calc Example]
 
-## Generating the lexer and the parser
+## Try it online
 
-```
-./gradlew generateParser
-```
+Play with the editor [online].
+
+## Or run it locally
 
-## Build everything and run the server
+You will need an installation of [Java 8+] and [Node 16+] to build the project. Then run
 
 ```
-npm install
-./gradlew generateParser
-tsc
-webpack
-cd server
-../gradlew runServer
+npm run all
 ```
 
-Now visit http://localhost:8888
+Now visit http://localhost:8888.
+
+
+[Writing a browser based editor using Monaco and ANTLR]: https://tomassetti.me/writing-a-browser-based-editor-using-monaco-and-antlr/
+[Calc Example]: ./doc/images/calc_example.png
+[Java 8+]: https://www.java.com/en/download/help/download_options.html
+[Node 16+]: https://nodejs.org/en
+[online]: https://minim.tools/calc-monaco-editor/