├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE └── README.md /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, gender identity and expression, level of experience, 9 | nationality, personal appearance, race, religion, or sexual identity and 10 | orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at [community@orbitdb.org](mailto:community@orbitdb.org), which goes to all members of the @OrbitDB community team, or to [richardlitt@orbitdb.org](mailto:richardlitt@orbitdb.org), which goes only to [@RichardLitt](https://github.com/RichardLitt) or to [haadcode@orbitdb.org](mailto:haadcode@orbitdb.org), which goes only to [@haadcode](https://github.com/haadcode). All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 72 | 73 | [homepage]: https://www.contributor-covenant.org 74 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contribute 2 | 3 | Please ensure that this is the right repo. Check in with us on Gitter, or open an issue, before opening a PR. Thanks. 4 | 5 | As always, abide by the [Code of Conduct](CODE_OF_CONDUCT.md). 6 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2015-2018 Protocol Labs Inc. 4 | Copyright (c) 2018-2019 Haja Networks Oy 5 | 6 | Permission is hereby granted, free of charge, to any person obtaining a copy 7 | of this software and associated documentation files (the "Software"), to deal 8 | in the Software without restriction, including without limitation the rights 9 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10 | copies of the Software, and to permit persons to whom the Software is 11 | furnished to do so, subject to the following conditions: 12 | 13 | The above copyright notice and this permission notice shall be included in all 14 | copies or substantial portions of the Software. 15 | 16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 | SOFTWARE. 23 | 24 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Orbit 2 | 3 | [![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/orbitdb/Lobby) [![Matrix](https://img.shields.io/badge/matrix-%23orbitdb%3Apermaweb.io-blue.svg)](https://riot.permaweb.io/#/room/#orbitdb:permaweb.io) 4 | 5 | > A distributed, serverless, peer-to-peer chat application on [IPFS](http://ipfs.io). 6 | 7 | If you're here, you're probably looking for: 8 | - [**orbit-db**](https://github.com/orbitdb/orbit-db) - The decentralized databases project 9 | - [**orbit-web**](https://github.com/orbitdb/orbit-web) - The current repository behind Orbit Chat, a p2p chat running on orbitdb. 10 | 11 | No work is currently being done in this repository. 12 | 13 | #### Try the web app at https://orbit.chat 14 | 15 | **NOTE!** _Orbit is still more or less experimental. It means Orbit is currently **not secure**, APIs will change and clients can break over time. If you come across problems, it would help greatly to open issues so that we can fix them as quickly as possible._ 16 | 17 | ## Clients 18 | 19 | **Browsers** 20 | 21 | Orbit chat application for the browsers. 22 | 23 | https://github.com/orbitdb/orbit-web 24 | 25 | 26 | 27 | 28 | **Desktops** 29 | 30 | A desktop version of the Orbit chat application that can be run as a stand-alone app in OSX and Linux. *We're currently working on Windows support.* 31 | 32 | https://github.com/orbitdb/orbit-electron 33 | 34 | 35 | 36 | 37 | **Terminal** 38 | 39 | A prototype of a terminal client. 40 | 41 | https://github.com/orbitdb/orbit-textui 42 | 43 | ## Core Library 44 | 45 | ### orbit-core 46 | 47 | Orbit is intended to be embeddable in applications. `orbit-core` is a JavaScript implementation which can be used in Node.js, Browser and Electron applications and on websites. 48 | 49 | [orbit-core](https://github.com/orbitdb/orbit-core) 50 | 51 | ### orbit-db 52 | 53 | A serverless, p2p database built on IPFS. Orbit uses `orbit-db` to have a database for each channel in the chat network. 54 | 55 | [orbit-db](https://github.com/haadcode/orbit-db) 56 | 57 | ### js-ipfs 58 | 59 | A new peer-to-peer hypermedia protocol. Orbit uses IPFS as its data storage and [libp2p](https://github.com/libp2p/js-libp2p) to handle all the p2p networking. 60 | 61 | - [js-ipfs](https://github.com/ipfs/js-ipfs) - IPFS JavaScript implementation 62 | - [go-ipfs](https://github.com/ipfs/go-ipfs) - IPFS Go implementation 63 | - https://github.com/ipfs/ipfs - IPFS on Github 64 | - https://ipfs.io - IPFS Website 65 | 66 | ## Contributing 67 | 68 | We would be happy to accept PRs! If you want to work on something, it'd be good to talk beforehand to make sure nobody else is working on it. You can reach us on [on Gitter](https://gitter.im/orbitdb/Lobby), or in the comments of the [issues section](https://github.com/orbitdb/orbit/issues). At the moment, progress in this particular repo is on hold. PRs are unlikely to be merged, and the issues are a bit stale. 69 | 70 | We also have **regular community calls**, which we announce in the issues in [the @orbitdb welcome repository](https://github.com/orbitdb/welcome/issues). Join us! 71 | 72 | For specific guidelines for contributing to this repository, check out the [Contributing guide](CONTRIBUTING.md). For more on contributing to OrbitDB in general, take a look at the [@OrbitDB welcome repository](https://github.com/orbitdb/welcome). Please note that all interactions in [@OrbitDB](https://github.com/orbitdb) fall under our [Code of Conduct](CODE_OF_CONDUCT.md). 73 | 74 | ## License 75 | 76 | [MIT](LICENSE) © 2015-2018 Protocol Labs Inc., 2018-2019 Haja Networks Oy 77 | --------------------------------------------------------------------------------