Ecosyste.ms: Awesome

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

https://github.com/tahnik/devRantron

A cross platform desktop application for devRant
https://github.com/tahnik/devRantron

devrant electron react react-router redux

Last synced: 9 days ago
JSON representation

A cross platform desktop application for devRant

Lists

README 

        
![devRantron Banner](https://i.imgur.com/dMWxH4x.png)

[![appveyor-badge]][appveyor-url]

[![travis-badge]][travis-url]

[![code-climate-badge]][code-climate-url]

[![code-coverage-badge]][code-coverage-url]

[![commitizen-badge]][commitizen-url]

[![github-total-downloads-badge]][github-total-downloads-url]

[![All Contributors][all-contributors-badge]](#contributors)

[![slack-badge]][slack-url]



> Unofficial devRant desktop client.



Works on Linux, MacOS and Windows.



---



## Table of Contents



- [Table of Contents](#table-of-contents)

- [Features](#features)

- [Installation](#installation)

- [Contribute](#contribute)

  - [How to setup the project](#how-to-setup-the-project)

  - [Commiting code](#commiting-code)

  - [Before pushing](#before-pushing)

- [Contributors](#contributors)



## Features



### Login with devRant Account

![Imgur](https://i.imgur.com/Tf1T1BR.png)

### View Rants and Make Comments

![Imgur](https://i.imgur.com/zGVFdqV.png)

### Post Rants and Pick Emojis!

![Imgur](https://i.imgur.com/FxJJ3jn.png)

### Get Real Time notifications

![Imgur](https://i.imgur.com/1XO7f4b.png)

### Make Your Custom View!

![Imgur](https://i.imgur.com/XFQC2aO.png)

### View Profiles

![Imgur](https://i.imgur.com/oPTZQLs.png)



> This is our approach to create a cross platform desktop application for [devRant.com].



## Installation



Pre-compiled builds can be found on the latest [release](https://github.com/tahnik/devRantron/releases/latest) page.

Additionally on macOS, `brew` can be used to install devRantron:



```

$ brew cask install devrantron

```



## Contribute



### How to setup the project



```bash

$ git clone https://github.com/tahnik/devRantron.git

$ cd devRantron

$ npm install

$ npm run dev

```



The `dev` script entry will start two processes. One process will create a `webpack-dev-server` that will watch and reload the bundle as you edit and will make it available at `http://localhost:8080`.

The second process will run the electron app in development mode, meaning that it will open up devtools with React and Redux devtools initialized.



### Commiting code



Make sure that your code is passing all linting tests before commiting it. This is usually done automatically by using `husky` precommit hooks.



devRantron uses angular styled commit messages. Messages that do not match the criteria are rejected. To make it easy to use them, use `git cz` instead of `git commit`.

It will start an interactive prompt and asks you for various things.



### Before pushing



Make sure that you add yourself as a contributor. Simply run `npm run contributors:add 



| [
Tahnik Mustasin](http://www.tahnik.com)
[💻](https://github.com/tahnik/devRantron/commits?author=tahnik "Code") [📖](https://github.com/tahnik/devRantron/commits?author=tahnik "Documentation") [📦](#platform-tahnik "Packaging/porting to new platform") [🔧](#tool-tahnik "Tools") | [
Hampus Lundqvist](https://mobooru.me)
[💻](https://github.com/tahnik/devRantron/commits?author=RekkyRek "Code") [🎨](#design-RekkyRek "Design") [📖](https://github.com/tahnik/devRantron/commits?author=RekkyRek "Documentation") [📦](#platform-RekkyRek "Packaging/porting to new platform") [🔧](#tool-RekkyRek "Tools") | [
SirWindfield](https://github.com/SirWindfield)
[💻](https://github.com/tahnik/devRantron/commits?author=SirWindfield "Code") [📖](https://github.com/tahnik/devRantron/commits?author=SirWindfield "Documentation") [🚇](#infra-SirWindfield "Infrastructure (Hosting, Build-Tools, etc)") [📦](#platform-SirWindfield "Packaging/porting to new platform") [🔧](#tool-SirWindfield "Tools") | [
David Refoua](http://www.Refoua.me)
[💻](https://github.com/tahnik/devRantron/commits?author=DRSDavidSoft "Code") | [
cozyplanes](http://cozyplanes.github.io)
[📖](https://github.com/tahnik/devRantron/commits?author=cozyplanes "Documentation") | [
Saurabh](http://blog.cryf.in)
[💻](https://github.com/tahnik/devRantron/commits?author=tkshnwesper "Code") | [
Dacexi](https://github.com/Dacexi)
[💻](https://github.com/tahnik/devRantron/commits?author=Dacexi "Code") [📖](https://github.com/tahnik/devRantron/commits?author=Dacexi "Documentation") |

| :---: | :---: | :---: | :---: | :---: | :---: | :---: |

| [
Markus Springer](https://github.com/xMarkusSpringerx)
[📖](https://github.com/tahnik/devRantron/commits?author=xMarkusSpringerx "Documentation") | [
Marcell Kovács](https://marcellkovacs.com/)
[💻](https://github.com/tahnik/devRantron/commits?author=kovaacs "Code") | [
Nathaniel Blackburn](http://nblackburn.uk)
[💻](https://github.com/tahnik/devRantron/commits?author=nblackburn "Code") | [
Metaa](https://metaa.io)
[💻](https://github.com/tahnik/devRantron/commits?author=metaa "Code") |



[all-contributors-badge]: https://img.shields.io/badge/all_contributors-11-orange.svg



[appveyor-badge]: https://img.shields.io/appveyor/ci/tahnik/devRantron/master.svg

[appveyor-url]: https://ci.appveyor.com/project/tahnik/devrantron



[code-climate-badge]: https://codeclimate.com/github/tahnik/devRantron/badges/gpa.svg

[code-climate-url]: https://codeclimate.com/github/tahnik/devRantron



[code-coverage-badge]: https://coveralls.io/repos/github/tahnik/devRantron/badge.svg?branch=master

[code-coverage-url]: https://coveralls.io/github/tahnik/devRantron?branch=master



[commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg

[commitizen-url]: http://commitizen.github.io/cz-cli/



[devRant.com]: 



[github-total-downloads-badge]: https://img.shields.io/github/downloads/tahnik/devRantron/total.svg

[github-total-downloads-url]: https://github.com/tahnik/devRantron/releases



[slack-badge]: https://img.shields.io/badge/slack-devRantron-blue.svg

[slack-url]: https://devrantron.slack.com/



[travis-badge]: https://img.shields.io/travis/tahnik/devRantron/master.svg

[travis-url]: https://travis-ci.org/tahnik/devRantron