diff --git a/README.md b/README.md new file mode 100644 index 0000000..6e162d7 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Vanilla.js Deck + +A Vanilla.js Single Page App (SPA) slide deck for a presentation about Vanilla.js. Yes, this is inception! No builds (unless you +count the included Docker image) and no frameworks, just pure JavaScript for a SPA application that features: + +- Routing (yes, you can bookmark/return to a slide) +- Transitions +- Reusable components +- Data-binding + +## Getting Started + +Optionally fork then clone the repo: + +`git clone https://github.com/JeremyLikness/vanillajs-deck.git` + +Spin up your favorite web server and point it to the root directory. There are no builds involved. + +One simple approach is to use Node.js and `http-server`: + +`npm i -g http-server` + +`cd vanillajs-deck` + +`http-server .` + +Navigate to one of the URLs with `index.html` as the path. + +### Docker setup + +If you prefer, you can build a Docker image and run the presentation from there. + +`cd vanillajs-deck` + +`docker built -t vanillajs-deck .` + +`docker run --rm -d -p 8080:80 vanillajs-deck` + +Navigate to `http://localhost:8080/index.html` to start the show.