Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tompascall/markdownnote
A simple note manager using Ionic framework.
https://github.com/tompascall/markdownnote
Last synced: about 1 month ago
JSON representation
A simple note manager using Ionic framework.
- Host: GitHub
- URL: https://github.com/tompascall/markdownnote
- Owner: tompascall
- License: mit
- Created: 2015-06-07T20:57:38.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-07-17T20:26:12.000Z (over 9 years ago)
- Last Synced: 2023-08-28T06:21:22.997Z (over 1 year ago)
- Language: JavaScript
- Size: 4.75 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#Markdown Note - a Simple Note Manager
This project is about developing a hybrid mobile app, using test-driven development approach, in [Ionic Framework](ionicframework.com).
The app is a note manager. You can **store** your notes locally or sync them to your Dropbox, you can **update** the content of notes and you can **filter** them by any keyword. You can also use **markdown language** to style and structure the body of your notes. As regards markdown editing we use the [marked](https://github.com/chjj/marked) library.
You can **download the android version** of the app from the [Google Play](https://play.google.com/store/apps/details?id=com.tompascall.MarkdownNote).
If you are curious about setting up the development framework, just check out the [**development.log.md**](https://github.com/tompascall/markdownNote/blob/master/development.log.md) file for the details.
##Prerequisites of building the app
- [Node.js](nodejs.org)
- Install Ionic and Cordova globally: ```$ npm install -g ionic cordova```
- Clone the project
- Install Node packages: ```$ npm install```
- Install Bower packages: ```$ bower install```
- You need [Grunt](http://gruntjs.com/) globally: ```$ npm install -g grunt```
- Follow the [Android](http://cordova.apache.org/docs/en/3.3.0/guide_platforms_android_index.md.html#Android%20Platform%20Guide) and [iOS](http://cordova.apache.org/docs/en/3.3.0/guide_platforms_ios_index.md.html#iOS%20Platform%20Guide) platform guides to install required platform dependencies
- Check out [Ionic Generator documentation](https://github.com/diegonetto/generator-ionic/tree/master/docs)
- I recommend checking out [my blogpost](http://js-workout.tompascall.com/lets-create-hybrid-mobile-apps-with-ionic-framework/) about creating hybrid mobile apps with Ionic framework and [this post](http://js-workout.tompascall.com/lets-develop-hybrid-mobile-apps-with-ionic-framework-ii/) about setting up dev framework for developing ionic app with TDD.
##Serve the app
For running the app in browser just run
```
$ grunt serve-online
```
For checking out the production code in your browser run
```
$ grunt serve-online:production
```
##Build the app
- Add platform: ```$ grunt platform:add:``` (ios / android)
- Build the project from the project library: ```$ grunt build```
As regards android platform you can find your built `.apk` in the `app/platforms/android/ant-build` folder.
###Build for dev environment
If you want to build the app in development environment (for using some built-in dev tools, such as adding a lot of test notes immediately), you can
```$ grunt build-dev[:]```
###Build online version
If you want to build the online version, then run
```$ grunt build-online```
###Build for release:
```$ grunt build: --release```
If you didn't have a key then you have to generate one:
```$ keytool -genkey -v -keystore my-release-key.keystore -alias -keyalg RSA -keysize 2048 -validity 10000```
(You will need this key later so save it watchfully)
Then you can sign your unsigned apk with `jarsigner`:
```$ jarsigner -verbose -sigalg SHA1withRSA -digestalg SHA1 -keystore my-release-key.keystore MarkdownNote-release-unsigned.apk ```
Finally you have to `zipalign`:
```$ zipalign -v 4 MarkdownNote-release-unsigned.apk MarkdownNote.apk```
##Run the app on device or emulator
You can
- emulate a device: ```$ grunt emulate:```
- run the app on a device: attach your device and ```$ grunt run```
- share the app via [Ionic View](http://view.ionic.io/)
For more information check out [Ionic Generator](https://github.com/diegonetto/generator-ionic#usage).
##Test the app
The test runs on [PhantomJS](http://phantomjs.org/), using the [Karma](http://karma-runner.github.io/0.12/index.html) test runner.
First you want to build the app or run ```grunt serve-online```. Then you can run your tests with ```$ grunt test```.