{"id":13631806,"url":"https://github.com/evrone/inboxes","last_synced_at":"2025-04-17T22:32:00.796Z","repository":{"id":65050404,"uuid":"2650952","full_name":"evrone/inboxes","owner":"evrone","description":"DEPRECATED: please note, this project is no longer being maintained","archived":true,"fork":false,"pushed_at":"2019-01-31T14:54:17.000Z","size":121,"stargazers_count":117,"open_issues_count":0,"forks_count":23,"subscribers_count":52,"default_branch":"master","last_synced_at":"2024-08-01T22:49:50.706Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://evrone.com","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/evrone.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-10-26T13:18:50.000Z","updated_at":"2023-01-28T19:04:54.000Z","dependencies_parsed_at":"2023-01-13T15:22:55.996Z","dependency_job_id":null,"html_url":"https://github.com/evrone/inboxes","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evrone%2Finboxes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evrone%2Finboxes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evrone%2Finboxes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evrone%2Finboxes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/evrone","download_url":"https://codeload.github.com/evrone/inboxes/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223768654,"owners_count":17199357,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T22:02:39.295Z","updated_at":"2024-11-08T23:31:39.730Z","avatar_url":"https://github.com/evrone.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"# PLEASE NOTE, THIS PROJECT IS NO LONGER BEING MAINTAINED\n# Inboxes\n\n[![Build Status](https://secure.travis-ci.org/evrone/inboxes.png)](http://travis-ci.org/evrone/inboxes)\n\nInboxes is a young messaging system for Rails app. It:\n\n- provides 3 models for developers: Discussion, Message and Speaker\n- read/unread discussions counter\n- any user can be invited to discussion by the member of this discussion, so you can chat with unlimited number of users\n- have configurable behavior via CanCan Ability\n\n\n\u003ca href=\"https://evrone.com/?utm_source=github.com\"\u003e\n  \u003cimg src=\"https://evrone.com/logo/evrone-sponsored-logo.png\"\n       alt=\"Sponsored by Evrone\" width=\"231\"\u003e\n\u003c/a\u003e\n\n## Getting Started\n### Prerequisites\n\nInboxes requires Rails 3.x and [Devise](https://github.com/plataformatec/devise) for user identification (surely, messaging system is not possible without users).\nWe recommend to use Inboxes with [Faye](https://github.com/jcoglan/faye), because it's really sexy with it.\n\nRemember that unfortunately, Inboxes reserve 3 resources names: Discussion, Message and Speaker.\n\nSince version 0.2.0, it is possible to add `has_inboxes` option to any model. For instance, it can be `Person` or `Teacher`.\n\n### Installation\n\n*Make sure that [Devise](https://github.com/plataformatec/devise) and [CanCan](https://github.com/ryanb/cancan) are already installed and configured in your app!*\n\n1. Add `gem \"inboxes\", \"~\u003e 0.2.0\"` to the `Gemfile` and run `bundle install`\n2. Execute `rails generate inboxes:install`. This command will generate migration for messaging system. Don't forget to run migrations: `rake db:migrate`\n3. Add `has_inboxes` to your User model like [here](https://gist.github.com/1330080).\n4. Add CanCan abilities to manage Inboxes models:\n\n```ruby\ncan [:index, :create], Discussion\ncan :read, Discussion do |discussion|\n  discussion.can_participate?(user)\nend\n```\n\n5. Now Inboxes are ready to use. Open `http://yoursite.dev/discussions` to see the list of discussions. You can start new one.\n\nDefault Inboxes views are ugly, so you can copy into your app and make anything with them: `rails generate inboxes:views`\nIf you have problems with installation, you can check [code of demo app](https://github.com/kirs/inboxes-app)\n\n### Usage\n\n#### I18n\n\nBy default, the gem provides localized phrases for Russian and English languages. \nYou can easily override any of them. \n[Here is](https://github.com/kirs/inboxes/blob/master/config/locales/en.yml) list of all I18n phrases.\n\n#### Integration with Faye\n\nYou can watch the demo of integration [on YouTube](http://youtu.be/c12gey9DvyU)\n\n1. Add `gem \"faye\"` to your Gemfile and run `bundle install`. Install Faye by [the screencast](http://railscasts.com/episodes/260-messaging-with-faye)\n2. Create `messaging.js` in `app/assets/javascripts/` with this line: `//= require inboxes/faye`\n\n3. Copy or replace 2 views from Inboxes example app to your application: [app/views/inboxes/messages/_form](https://github.com/kirs/inboxes-app/blob/master/app/views/inboxes/messages/_form.html.haml) and [app/views/inboxes/messages/create](https://github.com/kirs/inboxes-app/blob/master/app/views/inboxes/messages/create.js.erb)\n\n4. Add config parameters to your application config (last 2 are not necessary):\n\n```ruby\nconfig.inboxes.faye_enabled = true\nconfig.inboxes.faye_host = \"inboxes-app.dev\" # localhost by default\nconfig.inboxes.faye_port = 9292 # 9292 by default\n```\n\n5. Faye installation is finished. If you have any troubles, check the [example app](https://github.com/kirs/inboxes-app/)\n\n*While running Inboxes with Faye, don't forget to run Faye worker it: `rackup faye.ru -s thin -E production`*\nYou can read more about that on it's [official page](http://faye.jcoglan.com/).\n\n#### Hints\n\n1. If you want to add breadcrumbs to Inboxes pages, \nwe recommend you to use [crummy gem](https://github.com/zachinglis/crummy). \nIt allows to define breadcrumbs in views.\n2. Add Pusher capability\n3. Email notifications and the ability to answer received emails like in Github issues (#7)\n\n## Running the tests\n\nFinalize RSpec tests (are located in \n[rspec branch](https://github.com/evrone/inboxes/tree/rspec))\n\n## Contributing\n\nPlease read [Code of Conduct](CODE-OF-CONDUCT.md) and [Contributing Guidelines](CONTRIBUTING.md) for submitting pull requests to us.\n\n## Changelog\n\nThe changelog is [here](CHANGELOG.md).\n\n## Authors\n\n- [Kir Shatrov](https://github.com/kirs/) (Evrone Company)\n- [Nikolay Seskin](https://github.com/finist/) (Evrone Company)\n- [Andrey Ognevsky](https://github.com/ognevsy/) (Evrone Company)\n- [Alexander Brodyanoj](https://github.com/dom1nga)\n- [Dmitriy Kiriyenko](https://github.com/dmitriy-kiriyenko)\n- [Alexey Poimtsev](https://github.com/alec-c4) ([http://progress-engine.ru/](Progress Engine))\n- [isqad88](https://github.com/isqad88/)\n- [Chris Sargeant](https://github.com/liothen/)\n\nSee also the list of [contributors](https://github.com/evrone/inboxes/contributors) who participated in this project.\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevrone%2Finboxes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fevrone%2Finboxes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevrone%2Finboxes/lists"}