Urim

ToDo list tool with Urgency-Importance feature.

Install

1. Download zip or dmg from here for your OS.
2. unwrap zip or dmg, then place it to your favorite place.

Authors

• narugit
• asaiasa
• Gadpulse
• TauXdev

For Developers

Setup Development Environment

1. Install Git.

2. Install nvm-windows.

3. Install Node.js v11.14.0. Please launch Git Bash.

   $ nvm install 11.14.0
   $ nvm use 11.14.0
   $ node -v   # v11.14.0 
   

4. Update npm.

   $ npm -v
   $ npm update -g npm 
   

   However, you may get error. Therefore, your npm version has not been updated. Please try below commands.

   $ cd "$PROGRAMFILES"/nodejs
   $ rm npm npx npm.cmd npx.cmd
   $ mv node_modules/npm node_modules/npm2
   $ node node_modules/npm2/bin/npm-cli.js i -g npm@latest
   $ rm -rf node_modules/npm2/
   $ npm -v # v6.9.0
   

Development Procedure

1. Watch your error log when you save your editing code.

   $ npm run watch
   

2. Edit your code.

3. Debug.

   $ npm run start
   

Branch Rule

• master

  In this branch, all commits are guaranteed to execute.

• develop

  To synchronize some feature branches.

• feature/abcXyz/userName

  abcXyz: feature name wrote in camelCase

  userName: TauXdev, GadPulse, asaiasa, or narugit

  To synchronize some user's branches to complete abcXyz feature. You can create any branches under feature/abcXyz/userName. It's OK if you push the branches under feature/abcXyz/userName or not.

Commit Message Rule

Follow this guide.

Pull Request Rule

You can pull reqest and merge in any branch by yourself.

Documentation generator

Use TypeStrong/typedoc. Here is the guidline.

Style Guide

Use TypeScript Deep Dive.

UI Component (Will Do)

Use Material Design Lite.