https://github.com/hijiangtao/octo-note

A simple and small note app
https://github.com/hijiangtao/octo-note

html5-storage note-app pwa-apps vue2

Last synced: 7 months ago
JSON representation

A simple and small note app

• Host: GitHub
• URL: https://github.com/hijiangtao/octo-note
• Owner: hijiangtao
• License: apache-2.0
• Created: 2017-05-30T10:14:36.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-12-17T02:14:47.000Z (almost 8 years ago)
• Last Synced: 2025-01-12T15:09:39.906Z (9 months ago)
• Topics: html5-storage, note-app, pwa-apps, vue2
• Language: JavaScript
• Homepage: https://hijiangtao.github.io/octo-note/
• Size: 3.21 MB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Octo Note

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/78435b00b7264f03aec28f5a6cd9f038)](https://www.codacy.com/app/hijiangtao/octo-note?utm_source=github.com&utm_medium=referral&utm_content=hijiangtao/octo-note&utm_campaign=badger)

[![codebeat badge](https://codebeat.co/badges/9f27a9b8-3e2e-4d96-b319-ef0bf742a80e)](https://codebeat.co/projects/github-com-hijiangtao-octo-note-master)

> A simple and small note app that can run well in your device, even in uncertain network conditions.

## Preview 

![](/static/FireShot-Octo-Note.png )

Online: [link](https://hijiangtao.github.io/octo-note/) (PWA features can only be shown in some Chrome browsers with non-iOS environment)

## Features

* Note

* Weather

* Stock

## Some parts that worths to be mentioned:

* Vue 

* webpack (babel, eslint)

* Progressive Web App

* HTML5 (localstorage)

* WEUI

## Build Setup

You can download the codes and run it locally with the following guidances.

``` bash

# install dependencies

npm install

# serve with hot reload at localhost:8080

npm run dev

# build for production with minification

npm run build

# build for production and view the bundle analyzer report

npm run build --report

# run unit tests

npm run unit

# run e2e tests

npm run e2e

# run all tests

npm test

```

## Details

With the help of webpack plugin [**SW Precache Webpack Plugin**](https://github.com/goldhand/sw-precache-webpack-plugin), octo-note is a Progressive Web App now, that can run well in some Andriod and Windows Devices, for more detail please visit [Progressive Web Apps - Google Developers](https://developers.google.com/web/progressive-web-apps/).

## Contact

* Github - [hijiangtao](https:github.com/hijiangtao)

* [Email](mailto:hijiangtao@gmail.com)