https://github.com/skygear-demo/skypad

Skypad
https://github.com/skygear-demo/skypad

cloud collaboration javascript javascript-applications note-taking realtime realtime-collaboration serverless skygear

Last synced: 30 days ago
JSON representation

Skypad

• Host: GitHub
• URL: https://github.com/skygear-demo/skypad
• Owner: skygear-demo
• License: apache-2.0
• Created: 2017-07-26T17:12:30.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-04-02T10:30:41.000Z (over 5 years ago)
• Last Synced: 2024-08-04T01:25:23.365Z (4 months ago)
• Topics: cloud, collaboration, javascript, javascript-applications, note-taking, realtime, realtime-collaboration, serverless, skygear
• Language: JavaScript
• Homepage: https://skygear-demo.github.io/skypad
• Size: 185 KB
• Stars: 145
• Watchers: 7
• Forks: 11
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Skypad

Simple, real time collaborative notepad on the cloud. First version quickly built in an hour with [Skygear](https://skygear.io)

#### Try now:

* Create a new note: https://skygear-demo.github.io/skypad

![Code highlight Preview](https://user-images.githubusercontent.com/1916493/28747571-e14a8030-74d4-11e7-8c48-6f2edc1abc0c.gif)

## Non-CDN version

* This version's libraries are not served from any CDN. Suitable for independent deployment.

---

# Features

* Handy - Create a pad instantly.

* Simple UI - Neat, undistracting and responsive.

* Easy Sharing -  Share by URL, Twitter or FB.

* Collaboration - Real time sync across all platforms.

* Auto Save - Changes saved on the cloud automatically.

* Syntax Highligting - Support JavaScript, C, HTML and CSS. More comming.

[Try it here](https://skygear-demo.github.io/skypad)

# Develop

* Edit the `config` dict at `app.js`

```javascript

const config = {

  baseURL: "https://yoursite.com/", // To help generate a correct sharing URL

  skygearAPIEndpoint: "https://skypad.skygeario.com/", // API Endpoint

  skygearAPIKey: "xxxxc613xxxx4227xxxx6114a401xxxx", // API Key

  writerUser: "username", // the default user for creating app

  writerPass: "password"  // the default user password for creating app

}

```

* Sign up at [Skygear](https://portal.skygear.io/signup) to obtain the API Endpoint and API Key.

* Use `signupWithUserName` to create your own writerUser at Skygear.  

# Deploy

This app can be deployed on localhost, AWS s3, Skygear hosting, GitHub Page or other static hosts.

* These files are required to deploy:

  * `index.html` - Main layout

  * `app.js` - Main app logic

  * `app.css` - CSS styling

  * `/vendor` - Required external library files

# Versions

You can view the previous version as tags, e.g. `v0.1`, `v0.2`

* `mvp` Quick first usable version

* `v0.1` Social sharing and UI fixed

* `v0.2` Code highlighting

* `v0.3` Create new pad and pad title

* `v1.0` List of my notes (Automatically managed)

* `v1.1` **(Upcoming)** Private notes

# Feedback and Contribution

Feel free to open any issue and PR. Contact at [email protected]

### Credits & Thanks

* Code highlighting powered by [CodeFlask](https://github.com/kazzkiq/CodeFlask.js) by [kazzkiq](https://twitter.com/kazzkiq). That's awesome.

* CSS and base style: [MUI](https://www.muicss.com/) a lightweight material framework.

* I didn't use complex JS framework but [zepto.js](http://zeptojs.com/) for quick hacks and keep it lightweight.

### Mentions

* [Discussion on HN](https://news.ycombinator.com/item?id=14864089)



### About Skygear

[Skygear](https://skygear.io) is a backend for building real-time and cloud-based web/mobile app. Skypad is a perfect simple usecase.