https://github.com/kamataryo/react-prez

https://github.com/kamataryo/react-prez

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/kamataryo/react-prez
• Owner: kamataryo
• Created: 2017-05-05T02:55:35.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-07-21T07:18:42.000Z (over 7 years ago)
• Last Synced: 2024-12-18T06:51:32.971Z (about 1 month ago)
• Language: JavaScript
• Size: 2.15 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# React-Prez

[![Build Status](https://travis-ci.org/kamataryo/react-prez.svg?branch=master)](https://travis-ci.org/kamataryo/react-prez)

[![npm](https://img.shields.io/npm/v/react-prez.svg)](https://www.npmjs.com/package/react-prez)

Make presentations with React and Markdown!

[DEMO](https://kamataryo.github.io/react-prez/)

### install

```shell

$ npm install react react-dom prop-types --save

$ npm install react-prez --save

```

### usage

```jsx

import React      from 'react'

import { render } from 'react-dom'

import { Presentation, Slide } from 'react-prez'

const contents = [

  'presentation content0',

  'presentation content1',  

]

render(

  

    

    

  ,

  document.getElementById('app')

)

```

## development

```shell

$ git clone [email protected]:kamataryo/react-prez.git

$ cd react-prez

$ npm install

$ npm test  

$ npm run build

$ npm start

```

## release (for commiters)

```shell

$ npm version patch

```

## WebSocket controller (alpha)

1. Open presentation in both PC and iPhone. (Have not checked with Android yet.)

1. Connect to WebSocket Server, which running `./dist/index.js` on both device.

1. Authenticate with `admin:admin`(default) on both device.

1. Control presentation with your device. Gyro controller is Avairable.