https://github.com/w3tecch/express-typescript-boilerplate-presentation

Presentation about express-typescript-boilerplate
https://github.com/w3tecch/express-typescript-boilerplate-presentation

Last synced: about 2 months ago
JSON representation

Presentation about express-typescript-boilerplate

• Host: GitHub
• URL: https://github.com/w3tecch/express-typescript-boilerplate-presentation
• Owner: w3tecch
• Created: 2018-03-20T20:19:57.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-04-30T11:54:42.000Z (almost 7 years ago)
• Last Synced: 2025-01-13T12:22:10.957Z (3 months ago)
• Language: HTML
• Homepage: https://w3tecch.github.io/express-typescript-boilerplate-presentation/
• Size: 21.5 MB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  



Presentation about express-typescript-boilerplate




  Made with ❤️ by w3tech & contributors






## ❯ Why

Full configured [reveal.js](https://revealjs.com/) sample project with [webpack](https://webpack.js.org/) and some awesome features:

### Features

- **Markdown & HTML Support** Write your slides with the markdown or html language.

- **Sass** Define your styles with [Sass](https://sass-lang.com/).

- **Github Deployment** Run `npm start deploy` to deploy your builded presentation on th github pages.

![divider](./w3tec-divider.png)

## ❯ Table of Contents

- [Getting Started](#-getting-started)

- [Scripts and Tasks](#-scripts-and-tasks)

- [License](#-license)

![divider](./w3tec-divider.png)

## ❯ Getting Started

### Step 1: Set up the Development Environment

You need to set up your development environment before you can do anything.

Install [Node.js and NPM](https://nodejs.org/en/download/)

- on OSX use [homebrew](http://brew.sh) `brew install node`

- on Windows use [chocolatey](https://chocolatey.org/) `choco install nodejs`

Install yarn globally

```bash

npm install yarn -g

```

### Step 2: Serve your App

Go to the project dir and start your app with this npm script.

```bash

npm start

```

![divider](./w3tec-divider.png)

## ❯ Scripts and Tasks

All script are defined in the `package-scripts.js` file, but the most important ones are listed here.

### Install

- Install all dependencies with `yarn install`

### Serve

- Run `npm start` to serve your presentation locally

### Deploy

- Run `npm start deploy` to deploy your presentation on the github pages.

![divider](./w3tec-divider.png)

## ❯ License

[MIT](/LICENSE)