To receive notifications about scheduled maintenance, please subscribe to the mailing-list gitlab-operations@sympa.ethz.ch. You can subscribe to the mailing-list at https://sympa.ethz.ch

Commit 80509ba9 authored by kchung's avatar kchung 🚴🏻
Browse files

MES: update README and setup.sh

parent 4124b243
......@@ -14,10 +14,12 @@ Clone this repository to your local directory
git clone git@gitlab.ethz.ch:kchung/reveal-js-ifd-theme.git
```
Install dependencies (package.json should have revealjs and vite as devDependencies)
Run shell script to install dependencies. This script will install all ```nodejs``` dependencies and remove git related files and folder to avoid accidental commits while you are making the presentation.
**Removing git related files/folders is for personal reason. You shouldn't do that if you clone this repo.**
```bash
npm install
chmod 777 setup.sh
./setup.sh
```
Edit index.html to create reveal.js slides
......@@ -27,6 +29,7 @@ Then, start a local server to bundle and serve the presentation
npm run dev
```
Now, you can access to your slidese from your browser on localhost, port 3000 (localhost:3000)
## Integrate terminal inside of the slides
......@@ -34,3 +37,4 @@ Now, you can access to your slidese from your browser on localhost, port 3000 (l
You can add terminal inside of the slides. To accomplish this, you need to install dependencies in `ifd-theme/terminal/client` and `ifd-theme/terminal/server` by running ```npm install```.
Then, before using terminal, please run the server side application using ```npm start```
......@@ -10,3 +10,4 @@ cd ../../../
# remove git to avoid accidental commits
rm -rf .git
rm -rf .gitignore
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment