README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

![Banner](docs/banner/Banner.png "Banner")
# <img src="docs/logo/logo.png" width="26px">&nbsp; authorr

A desktop app for authors. 

[![Build Status](https://travis-ci.com/luciferreeves/authorr.svg?branch=master)](https://travis-ci.com/luciferreeves/authorr) ![David](https://img.shields.io/david/luciferreeves/authorr.svg) ![GitHub issues](https://img.shields.io/github/issues/luciferreeves/authorr.svg) ![GitHub](https://img.shields.io/github/license/luciferreeves/authorr.svg) ![GitHub package.json version](https://img.shields.io/github/package-json/v/luciferreeves/authorr.svg) 

#### An Original Project By Kumar Priyansh which lives [here](https://luciferreeves.github.io/authorr/).

<img src="docs/extras/runsonmac.png" height="70px">

##### This app is not available with Windows or Linux based distros. However, it could be made available on those platforms by cloning and making necessary changes.

## For Developers:

- ### Cloning:
  ````
  git clone https://github.com/luciferreeves/authorr
  ````
- ### Dependencies:
    ````
    "dependencies": {
        "jquery": "^3.4.1",
        "local-storage": "^2.0.0"
    }

    "devDependencies": {
        "electron": "^5.0.3",
        "@fortawesome/fontawesome-free": "^5.9.0",
        "electron-builder": "^20.43.0"
    }
    ````
- ### How to get started on macOS:

        npm install && npm start