diff --git a/.editorconfig b/.editorconfig index 59b8db48..d52dd70c 100644 --- a/.editorconfig +++ b/.editorconfig @@ -10,6 +10,11 @@ insert_final_newline = true indent_style = tab tab_width = 2 -[*{yml,yaml}] +[*.{yml,yaml}] indent_style = space indent_size = 2 + +[*.{md}] +indent_style = space +indent_size = 4 +trim_trailing_whitespace = false diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index a1bcd202..b714967a 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,10 +1,12 @@ +# Contributing + ## Submitting issues -* Please search the existing issues first, it's likely that your issue was already reported or even fixed. +- Please search the existing issues first, it's likely that your issue was already reported or even fixed. - Go to "Issues" and type any word in the top search/command bar. - Consider to search on closed issues. To do that just remove "is:open" from the search field. - More info on [search syntax within github](https://help.github.com/articles/searching-issues) -* Report the issue using our [template][template], it includes all the information we need to track down the issue. +- Report the issue using our [template][template], it includes all the information we need to track down the issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. @@ -27,6 +29,7 @@ We have a great community in [Gitter][gitter] that can help you with any doubt o Feel free to create pull requests to help us offer a great and complete software. :wink: ## Translations -Please submit translations via [Transifex][transifex]. -[transifex]: https://www.transifex.com/rambox/rambox-app/ +Please submit translations via [Crowdin][crowdin]. + +[crowdin]: https://crowdin.com/project/rambox/ diff --git a/.gitignore b/.gitignore index e5c535d3..43ccc544 100644 --- a/.gitignore +++ b/.gitignore @@ -1,10 +1,10 @@ # Sencha (ExtJS) -/build/development -/build/production -/build/temp +build/development/ +build/production/ +build/temp/ .sass-cache/ .sass_cache/ -/dist +dist/ # OS generated files # ###################### @@ -18,8 +18,8 @@ Thumbs.db # IDE generated files # ###################### -.project -.idea +.project/ +.idea/ # bootstrap files are regenerated by Sencha CMD on every build or refresh bootstrap.js @@ -27,11 +27,12 @@ bootstrap.css bootstrap.json # Electron -node_modules +node_modules/ npm-debug.log # Vagrant -/.vagrant +.vagrant/ + env.js rambox_cfg.json languages.js diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 08506148..ab6c88aa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,16 +3,12 @@ We welcome pull requests! Follow these steps to contribute: 1. Find an [issue](https://github.com/saenzramiro/rambox/issues) that needs assistance. +1. Let us know you are working on it by posting a comment on the issue. +1. Follow the [Contribution Guidelines](#contribution-guidelines) to start working on the issue. -2. Let us know you are working on it by posting a comment on the issue. +Working on your first Pull Request? You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) -3. Follow the [Contribution Guidelines](#contribution-guidelines) to start working on the issue. - -Working on your first Pull Request? You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub] - -(https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) - -###### If you've found a bug that is not on the board, [follow these steps](README.md#found-a-bug). +##### If you've found a bug that is not on the board, [follow these steps](README.md#found-a-bug). -------------------------------------------------------------------------------- @@ -41,10 +37,10 @@ Working on your first Pull Request? You can learn how from this *free* series [H ### Prerequisites -| Prerequisite | Version | -| ------------------------------------------------------------- | ------- | -| [Sencha](https://www.sencha.com/products/extjs/cmd-download/) | `=6.1.2.15` | -| [Ruby](https://www.ruby-lang.org/en/downloads/) | `=2.3` | +| Prerequisite | Version | +| ------------------------------------------------------------- | ----------- | +| [Sencha](https://www.sencha.com/products/extjs/cmd-download/) | `=6.1.2.15` | +| [Ruby](https://www.ruby-lang.org/en/downloads/) | `=2.3` | | [Node.js](http://nodejs.org) | `~ ^4.0.0` | | npm (comes with Node) | `~ ^3.8.7` | @@ -65,21 +61,21 @@ If your versions are lower than the prerequisite versions, you should update. #### Setting Up Your System 1. Install [Git](https://git-scm.com/) or your favorite Git client. -2. (Optional) [Setup an SSH Key](https://help.github.com/articles/generating-an-ssh-key/) for GitHub. +1. (Optional) [Setup an SSH Key](https://help.github.com/articles/generating-an-ssh-key/) for GitHub. #### Forking rambox 1. Go to the top level rambox repository: -2. Click the "Fork" Button in the upper right hand corner of the interface ([More Details Here](https://help.github.com/articles/fork-a-repo/)) -3. After the repository (repo) has been forked, you will be taken to your copy of the rambox repo at +1. Click the "Fork" Button in the upper right hand corner of the interface ([More Details Here](https://help.github.com/articles/fork-a-repo/)) +1. After the repository (repo) has been forked, you will be taken to your copy of the rambox repo at #### Cloning Your Fork 1. Open a Terminal / Command Line / Bash Shell in your projects directory (_i.e.: `/yourprojectdirectory/`_) -2. Clone your fork of rambox +1. Clone your fork of rambox ```shell -$ git clone https://github.com/yourUsername/rambox.git +git clone https://github.com/yourUsername/rambox.git ``` **(make sure to replace `yourUsername` with your GitHub username)** @@ -89,10 +85,10 @@ This will download the entire rambox repo to your projects directory. #### Setup Your Upstream 1. Change directory to the new rambox directory (`cd rambox`) -2. Add a remote to the official rambox repo: +1. Add a remote to the official rambox repo: ```shell -$ git remote add upstream https://github.com/saenzramiro/rambox.git +git remote add upstream https://github.com/saenzramiro/rambox.git ``` Congratulations, you now have a local copy of the rambox repo! @@ -103,7 +99,7 @@ Before you start working, you will need to create a separate branch specific to #### Naming Your Branch -Name the branch something like `fix/xxx` or `feature/xxx` where `xxx` is a short description of the changes or feature you are attempting to add. For example +Name the branch something like `fix/xxx` or `feature/xxx` where `xxx` is a short description of the changes or feature you are attempting to add. For example `fix/email-login` would be a branch where you fix something specific to email login. @@ -112,13 +108,13 @@ Name the branch something like `fix/xxx` or `feature/xxx` where `xxx` is a short To create a branch on your local machine (and switch to this branch): ```shell -$ git checkout -b [name_of_your_new_branch] +git checkout -b [name_of_your_new_branch] ``` and to push to GitHub: ```shell -$ git push origin [name_of_your_new_branch] +git push origin [name_of_your_new_branch] ``` **If you need more help with branching, take a look at [this](https://github.com/Kunena/Kunena-Forum/wiki/Create-a-new-branch-with-git-and-manage-branches).** @@ -145,12 +141,13 @@ cp env-sample.js env.js # Windows copy env-sample.js env.js ``` + Then edit the `env.js` file and modify the API keys only for services that you will use. ```bash -# Compile the files... -$ sencha app watch -$ npm start # in a new terminal +# Compile the files... +sencha app watch +npm start # in a new terminal ``` ### Make Changes @@ -159,12 +156,10 @@ This bit is up to you! #### How to find the code in the rambox codebase to fix/edit -The best way to find out any code you wish to change/add or remove is using -the GitHub search bar at the top of the repository page. For example, you could -search for a challenge name and the results will display all the files along -with line numbers. Then you can proceed to the files and verify this is the area -that you were looking forward to edit. Always feel free to reach out to the chat -room when you are not certain of any thing specific in the code. +The best way to find out any code you wish to change/add or remove is using the GitHub search bar at the top of the repository page. +For example, you could search for a challenge name and the results will display all the files along with line numbers. +Then you can proceed to the files and verify this is the area that you were looking forward to edit. +Always feel free to reach out to the chat room when you are not certain of any thing specific in the code. #### Adding or Editing Services @@ -178,71 +173,46 @@ To see these changes you'll need to stop your `npm start` and `sencha app watch` #### What is a Pull Request? -A pull request (PR) is a method of submitting proposed changes to the rambox -repo (or any repo, for that matter). You will make changes to copies of the -files which make up rambox in a personal fork, then apply to have them -accepted by rambox proper. +A pull request (PR) is a method of submitting proposed changes to the rambox repo (or any repo, for that matter). +You will make changes to copies of thefiles which make up rambox in a personal fork, then apply to have them accepted by rambox proper. #### Important: ALWAYS EDIT ON A BRANCH -Take away only one thing from this document: Never, **EVER** -make edits to the `staging` branch. ALWAYS make a new branch BEFORE you edit -files. This is critical, because if your PR is not accepted, your copy of -staging will be forever sullied and the only way to fix it is to delete your -fork and re-fork. +Take away only one thing from this document: Never, **EVER** make edits to the `staging` branch. +ALWAYS make a new branch BEFORE you edit files. +This is critical, because if your PR is not accepted, your copy of staging will be forever sullied and the only way to fix it is to delete your fork and re-fork. ### Common Steps -1. Once the edits have been committed, you will be prompted to create a pull - request on your fork's GitHub Page. - -2. By default, all pull requests should be against the rambox main repo, `staging` - branch. - **Make sure that your Base Fork is set to saenzramiro/rambox when raising a Pull Request.** - -3. Submit a pull request. - -4. The title (also called the subject) of your PR should be descriptive of your - changes and succinctly indicates what is being fixed. - - - **Do not add the issue number in the PR title or commit message.** - - - Examples: `Added Service servicename` `Correct typo in menu` - -5. In the body of your PR include a more detailed summary of the changes you - made and why. - - - If the PR is meant to fix an existing bug/issue then, at the end of - your PR's description, append the keyword `closes` and #xxxx (where xxxx - is the issue number). Example: `closes #1337`. This tells GitHub to - close the existing issue, if the PR is merged. - -6. Indicate if you have tested on a local copy of the site or not. +1. Once the edits have been committed, you will be prompted to create a pull request on your fork's GitHub Page. +1. By default, all pull requests should be against the rambox main repo, `staging` branch. + - **Make sure that your Base Fork is set to saenzramiro/rambox when raising a Pull Request.** +1. Submit a pull request. +1. The title (also called the subject) of your PR should be descriptive of your changes and succinctly indicates what is being fixed. + - **Do not add the issue number in the PR title or commit message.** + - Examples: `Added Service servicename` `Correct typo in menu` +1. In the body of your PR include a more detailed summary of the changes you made and why. + - If the PR is meant to fix an existing bug/issue then, at the end of your PR's description, append the keyword `closes` and #xxxx (where xxxx is the issue number). + - Example: `closes #1337`. This tells GitHub to automatically close the existing issue, if the PR is merged. +1. Indicate if you have tested on a local copy of the site or not. ### How We Review and Merge Pull Requests -rambox has a team of volunteer Issue Moderators. These Issue Moderators routinely go through open pull requests in a process called [Quality Assurance] - -(https://en.wikipedia.org/wiki/Quality_assurance) (QA). - -1. If an Issue Moderator QA's a pull request and confirms that the new code does what it is supposed without seeming to introduce any new bugs, they will comment +Rambox has a team of volunteer Issue Moderators. These Issue Moderators routinely go through open pull requests in a process called [Quality Assurance](https://en.wikipedia.org/wiki/Quality_assurance) (QA). -"LGTM" which means "Looks good to me." +1. If an Issue Moderator QA's a pull request and confirms that the new code does what it is supposed without seeming to introduce any new bugs, they will comment: `"LGTM" which means "Looks good to me."` +1. Another Issue Moderator will QA the same pull request. + - Once they have also confirmed that the new code does what it is supposed to without seeming to introduce any new bugs, they will merge the pull request. -2. Another Issue Moderator will QA the same pull request. Once they have also confirmed that the new code does what it is supposed to without seeming to introduce - -any new bugs, they will merge the pull request. - -If you would like to apply to join our Issue Moderator team - which is a Core Team position - message [@BerkeleyTrue](https://gitter.im/berkeleytrue) with links - -to 5 of your pull requests that have been accepted and 5 issues where you have helped someone else through commenting or QA'ing. +If you would like to apply to join our Issue Moderator team - which is a Core Team position - message [@BerkeleyTrue](https://gitter.im/berkeleytrue) with links to 5 of your pull requests that have been accepted and 5 issues where you have helped someone else through commenting or QA'ing. ### How We Close Stale Issues We will close any issues or pull requests that have been inactive for more than 15 days, except those that match the following criteria: -- bugs that are confirmed -- pull requests that are waiting on other pull requests to be merged -- features that are a part of a GitHub project + +- Bugs that are confirmed +- Pull requests that are waiting on other pull requests to be merged +- Features that are a part of a GitHub project ### Next Steps @@ -251,21 +221,17 @@ We will close any issues or pull requests that have been inactive for more than Once your PR is accepted, you may delete the branch you created to submit it. This keeps your working fork clean. -You can do this with a press of a button on the GitHub PR interface. You can -delete the local copy of the branch with: `git branch -D branch/to-delete-name` +You can do this with a press of a button on the GitHub PR interface. You can delete the local copy of the branch with: `git branch -D branch/to-delete-name` #### If your PR is rejected -Don't despair! You should receive solid feedback as to -why it was rejected and what changes are needed. +Don't despair! You should receive solid feedback as to why it was rejected and what changes are needed. -Many Pull Requests, especially first Pull Requests, require correction or -updating. If you have used the GitHub interface to create your PR, you will need -to close your PR, create a new branch, and re-submit. +Many Pull Requests, especially first Pull Requests, require correction or updating. +If you have used the GitHub interface to create your PR, you will need to close your PR, create a new branch, and re-submit. -If you have a local copy of the repo, you can make the requested changes and -amend your commit with: `git commit --amend` This will update your existing -commit. When you push it to your fork you will need to do a force push to -overwrite your old commit: `git push --force` +If you have a local copy of the repo, you can make the requested changes and amend your commit with: `git commit --amend` This will update your existing +commit. +When you push it to your fork you will need to do a force push to overwrite your old commit: `git push --force` -Be sure to post in the PR conversation that you have made the requested changes. \ No newline at end of file +Be sure to post in the PR conversation that you have made the requested changes. diff --git a/README.md b/README.md index 90bbcef5..293ac1c6 100644 --- a/README.md +++ b/README.md @@ -1,163 +1,164 @@ -

-
- Rambox -
- Rambox -
-
-

- -

Free, Open Source and Cross Platform messaging and emailing app that combines common web applications into one.

- -

- Donate with PayPal - GNU GPL v3 - Gitter - Release - -

-

- Travis CI - AppVeyor CI - - -

- -
Available for Windows, Mac and Linux.
- -
DOWNLOAD HERE
- -
Logo designed by Andriy Yurchenko
- ----------- +
+

+
+ Rambox
+ Rambox +

+

+ +

Free, Open Source and Cross Platform messaging and emailing app that combines common web applications into one.

+ +

+ Donate with PayPal + GNU GPL v3 + Gitter + + Release + + +

+

+ Travis CI + AppVeyor CI + + +

+ +
Available for Windows, Mac and Linux.
+ +
DOWNLOAD HERE
+ +
Logo designed by Andriy Yurchenko
+
+ +--- ## Table of Contents +- [Table of Contents](#table-of-contents) - [Screenshot](#screenshot) -- [Services available - 89](#services-available---95) +- [Services available - 98](#services-available---98) - [Features](#features) - [Privacy](#privacy) - [Donations](#donations) - [Translations](#translations) - [Install on Linux - Steps](#install-on-linux---steps) -- [To Do](#to-do) - [Contributing](#contributing) + - [Quickstart](#quickstart) - [Disclosure](#disclosure) - [Licence](#licence) ----------- +--- ## Screenshot -![Rambox](https://raw.githubusercontent.com/saenzramiro/rambox/master/resources/screenshots/mac.png) - +![Rambox](./resources/screenshots/mac.png) ## Services available - 98 -WhatsApp -Messenger -Skype -Slack -Hangouts -Telegram -WeChat -Gmail -Inbox -HipChat -Allo - -ChatWork -GroupMe -Grape -Gitter -Steam -Discord -Noysi -Outlook -Outlook 365 -TutaNota - -Hushmail -BearyChat -Aol -Sync -Wire -Rocket Chat -Missive -Yahoo! Mail -Ryver - -Yandex Mail -Dasher -DingTalk -FlowDock -Mattermost -Voxer -Glip -Yahoo! Messenger -mysms -ICQ - -TweetDeck -Zinc -FreeNode -MightyText -Zoho Email -Zoho Chat -Roundcube -Horde -SquirrelMail -Zimbra - -Hootsuite -Amium -RainLoop -iCloud Mail -IRC Cloud -Kiwi IRC -Smooch -Crisp -Flock -Openmailbox - -Typetalk -Drift -Cisco Spark -Fleep -Socialcast -Riot -Pushbullet -Movim - -Kaiwa -Zyptonite -LinkedIn -The Lounge -Kezmo -Teams -Xing -Workplace -FastMail -Hibox -Jandi -Threema -Messenger for Pages -VK Messenger -Mastodon -Teamwork Chat -ClockTweets -Intercom -Voice -Sandstorm -Gadu-Gadu -Mail.Ru -Kune -Zulip -Stride -Hangouts Chat -Messenger for Business - -











































+WhatsApp +Messenger +Skype +Slack +Hangouts +Telegram +WeChat +Gmail +Inbox +HipChat +Allo + +ChatWork +GroupMe +Grape +Gitter +Steam +Discord +Noysi +Outlook +Outlook 365 +TutaNota +Hushmail + +BearyChat +Aol +Sync +Wire +Rocket Chat +Missive +Yahoo! Mail +Ryver +Yandex Mail +Dasher +DingTalk + +FlowDock +Mattermost +Voxer +Glip +Yahoo! Messenger +mysms +ICQ +TweetDeck +Zinc +FreeNode +MightyText + +Zoho Email +Zoho Chat +Roundcube +Horde +SquirrelMail +Zimbra +Hootsuite +Amium +RainLoop +iCloud Mail +IRC Cloud + +Kiwi IRC +Smooch +Crisp +Flock +Openmailbox +Typetalk +Drift +Cisco Spark +Fleep +Socialcast +Riot + +Pushbullet +Movim +Kaiwa +Zyptonite +LinkedIn +The Lounge +Kezmo +Teams +Xing +Workplace +FastMail + +Hibox +Jandi +Threema +Messenger for Pages +VK Messenger +Mastodon +Teamwork Chat +ClockTweets +Intercom +Voice +Sandstorm + +Gadu-Gadu +Mail.Ru +Kune +Zulip +Stride +Hangouts Chat +Messenger for Business ## Features @@ -181,28 +182,32 @@ No personal information will be saved -Sessions will persist using the [partition:persist](https://electronjs.org/docs/api/webview-tag#partition) attribute for Webviews. So every time you open Rambox, your sessions will keep alive until you remove the service. +Sessions will persist using the [partition:persist](https://electronjs.org/docs/api/webview-tag#partition) attribute for Webviews. +So every time you open Rambox, your sessions will keep alive until you remove the service. -Sync feature use Auth0 for Single Sign On & Token Based Authentication and to store the services that user is using (and the configuration for each service). You are always welcome to check the code! ;) +Sync feature use Auth0 for Single Sign On & Token Based Authentication and to store the services that user is using (and the configuration for each service). +You are always welcome to check the code! ;) ## Donations -| Type | URL/Wallet | -|--------------------|:------------------------------------------------------------------------------------------:| -| PayPal | [HERE](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=WU75QWS7LH2CA) | -| Cryptocurrencies | [HERE](https://www.vaulty.io/v/b6480279-af28-4855-868c-17e5cb0ae7fa) | +| Type | URL/Wallet | +| ---------------- | :----------------------------------------------------------------------------------------: | +| PayPal | [HERE](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=WU75QWS7LH2CA) | +| Cryptocurrencies | [HERE](https://www.vaulty.io/v/b6480279-af28-4855-868c-17e5cb0ae7fa) | ## Translations -Help us translate Rambox on https://crowdin.com/project/rambox/invite. +Help us translate Rambox on . ## [Install on Linux - Steps](https://github.com/saenzramiro/rambox/wiki/Install-on-Linux) -## Contributing +## [Contributing](./CONTRIBUTING.md) -Want to report a bug, request a feature, contribute to or translate Rambox? We need all the help we can get! Fork and work! +Want to report a bug, request a feature, contribute to or translate Rambox? +We need all the help we can get! +Fork and work! -### Quickstart: +### Quickstart ```shell git clone https://github.com/saenzramiro/rambox.git @@ -214,16 +219,14 @@ sencha app watch npm start ``` -See [Contributing.md](https://github.com/saenzramiro/rambox/blob/master/CONTRIBUTING.md) for more detailed information about getting set up. +See [Contributing.md](./CONTRIBUTING.md) for more detailed information about getting set up. -------------------- +--- -Disclosure -------------------- +## Disclosure Rambox is not affiliated with any of the messaging apps offered. -Licence -------------------- +## Licence [GNU GPL v3](https://github.com/saenzramiro/rambox/LICENSE) diff --git a/app/Readme.md b/app/Readme.md index 4942954b..2b351cb2 100644 --- a/app/Readme.md +++ b/app/Readme.md @@ -1,7 +1,7 @@ # ./controller This folder contains the application's global controllers. ViewControllers are located -alongside their respective view class in `"./view"`. These controllers are used for routing +alongside their respective view class in `./view`. These controllers are used for routing and other activities that span all views. # ./model @@ -15,11 +15,13 @@ application's architecture. Pure MVC applications may not have ViewModels, for e MVCVM applications or MVC applications that use ViewControllers, the following directory structure is recommended: - ./view/ - foo/ # Some meaningful grouping of one or more views - Foo.js # The view class - FooController.js # The controller for Foo (a ViewController) - FooModel.js # The ViewModel for Foo +```text +./view/ + foo/ # Some meaningful grouping of one or more views + Foo.js # The view class + FooController.js # The controller for Foo (a ViewController) + FooModel.js # The ViewModel for Foo +``` This structure helps keep these closely related classes together and easily identifiable in most tabbed IDE's or text editors.