Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/byronhsu/life-commit

🏃📆 Life as a git. Commit on your life.
https://github.com/byronhsu/life-commit

cli commit git life nodejs

Last synced: 4 days ago
JSON representation

🏃📆 Life as a git. Commit on your life.

Awesome Lists containing this project

README

        








> 🏃📆 Life as a git. Commit on your life.

## Demo



:rocket: Discuss it on Product Hunt!

### My Website

https://byronhsu.github.io/life-commit/

## Install
In order to use life-commit, make sure that you have Node version 6.0.0 or higher.

```
$ npm install -g life-commit
```

## Usage

### overview
```
Usage
$ life
Options
--init, -i
--commit, -c
--log, -l
--edit , -e
--dir, -d [folder name]
Examples
$ life --commit
$ life --log
```
### options

#### ``--init`` or ``-i``
```
$ life --init
```
Initialize your life

#### ``--commit`` or ``-c``
```
$ life --commit
```
Commit on your life

#### ``--log`` or ``-l``
```
$ life --log
```
Log the commits on your life

#### ``--edit`` or ``-e``
```
$ life --edit 06f302
```
Edit the existing commits

#### ``--dir`` or ``-d``
```
$ life --dir myfolder
```
Create a directory that visualizing the commits on webpage

## Contribute
- Define lifemojis

All the lifemojis are stored at ``/src/data/lifemojis.json``. Comment at [issue#2](https://github.com/ByronHsu/life-commit/issues/2) with an **emoji** and **description**. Let's brainstorm and define more and more creative lifemojis together!

Format:
```js
{
"emoji": "🚚",
"description": "Made a move"
},
{
"emoji": "👰",
"description": "Got married"
},
{
"emoji": "👨‍👩‍👧",
"description": "Had a child"
},
```
- Code

Send PRs directly!
## Credits

[Elegant UI design by Bruno Rodrigues](https://codepen.io/itbruno/pen/KwarLp)

Creative project [gitmoji-cli](https://github.com/carloscuesta/gitmoji-cli) and [gitmoji](https://github.com/carloscuesta/gitmoji) by [Carlos Cuesta](https://github.com/carloscuesta)

LOGO desinged by [Gary Chiang](https://www.facebook.com/gary8621)