diff --git a/.github/CONDUCT.md b/.github/CONDUCT.md deleted file mode 100644 index f7460f1..0000000 --- a/.github/CONDUCT.md +++ /dev/null @@ -1,72 +0,0 @@ -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, gender identity and expression, level of experience, -nationality, personal appearance, race, religion, or sexual identity and -orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or -advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at [INSERT EMAIL ADDRESS]. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at [http://contributor-covenant.org/version/1/4][version] - -[homepage]: http://contributor-covenant.org -[version]: http://contributor-covenant.org/version/1/4/ diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md deleted file mode 100644 index 83f4b77..0000000 --- a/.github/CONTRIBUTING.md +++ /dev/null @@ -1,43 +0,0 @@ -# Contributing Guidelines - -For anyone looking to get involved to this project, we are glad to hear from you. Here are a few types of contributions -that we would be interested in hearing about. - -* Bug fixes - - If you find a bug, please first report it using Github issues. - - Issues that have already been identified as a bug will be labeled `bug`. - - If you'd like to submit a fix for a bug, create a Pull Request from your own fork and mention the issue number. - + Include a test that isolates the bug and verifies that it was fixed. -* New Features - - If you'd like to accomplish something in the library that it doesn't already do, describe the problem in a new - Github issue. - - Issues that have been identified as a feature request will be labeled `enhancement`. - - If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending - too much time writing the code. In some cases, `enhancement`s may not align well with the project objectives at - the time. -* Tests, Documentation, Miscellaneous - - If you think the test coverage could be improved, the documentation could be clearer, you've got an alternative - implementation of something that may have more advantages, or any other change we would still be glad hear about - it. - - If it's a trivial change, go ahead and create a Pull Request with the changes you have in mind - - If not, open a Github issue to discuss the idea first. - -## Requirements - -For a contribution to be accepted: - -* The test suite must be complete and pass -* Code must follow existing styling conventions -* Commit messages must be descriptive. Related issues should be mentioned by number. - -If the contribution doesn't meet these criteria, a maintainer will discuss it with you on the issue. You can still -continue to add more commits to the branch you have sent the Pull Request from. - -## How To Start - -1. Fork this repository on GitHub. -1. Clone/fetch your fork to your local development machine. -1. Create a new branch (e.g. `issue-12`, `feat.add_foo`, etc) and check it out. -1. Make your changes and commit them. (Did the tests pass?) -1. Push your new branch to your fork. (e.g. `git push myname issue-12`) -1. Open a Pull Request from your new branch to the original fork's `master` branch. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..88621f1 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +- Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +- The use of sexualized language or imagery, and sexual attention or + advances of any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email + address, without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +devrel@vonage.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..bf839d6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,37 @@ +# Contributing Guidelines + +For anyone looking to get involved to this project, we are glad to hear from you. Here are a few types of contributions +that we would be interested in hearing about. + +- Bug fixes + - If you find a bug, please first report it using Github Issues. + - Issues that have already been identified as a bug will be labelled `bug`. + - If you'd like to submit a fix for a bug, send a Pull Request from your own fork and mention the Issue number. + - Include a test that isolates the bug and verifies that it was fixed. +- New Features + - If you'd like to accomplish something in the library that it doesn't already do, describe the problem in a new Github Issue. + - Issues that have been identified as a feature request will be labelled `enhancement`. + - If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending too much time writing the code. In some cases, `enhancement`s may not align well with the project objectives at the time. +- Tests, Documentation, Miscellaneous + - If you think the test coverage could be improved, the documentation could be clearer, you've got an alternative implementation of something that may have more advantages, or any other change we would still be glad hear about it. + - If its a trivial change, go ahead and send a Pull Request with the changes you have in mind + - If not, open a Github Issue to discuss the idea first. + +## Requirements + +For a contribution to be accepted: + +- The test suite must be complete and pass +- Code must follow existing styling conventions +- Commit messages must be descriptive. Related issues should be mentioned by number. + +If the contribution doesn't meet these criteria, a maintainer will discuss it with you on the Issue. You can still continue to add more commits to the branch you have sent the Pull Request from. + +## How To + +1. Fork this repository on GitHub. +1. Clone/fetch your fork to your local development machine. +1. Create a new branch (e.g. `issue-12`, `feat.add_foo`, etc) and check it out. +1. Make your changes and commit them. (Did the tests pass?) +1. Push your new branch to your fork. (e.g. `git push myname issue-12`) +1. Open a Pull Request from your new branch to the original fork's `master` branch. diff --git a/README.md b/README.md index 8c3e0f1..e1bf5fe 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,28 @@ # OpenTok Accelerator Sample Apps for JavaScript + +Tokbox is now known as Vonage + ## Introduction + In this repository there are three example applications demonstrating how to use [opentok-accelerator-core-js](https://github.com/opentok/accelerator-core-js): - [Vanilla JS Sample with Accelerator Core](/vanilla-js-sample-app) - [React JS Sample with Accelerator Core](/react-sample-app) - [React JS Sample with Accelerator Core with SDK Wrapper](/sdk-wrapper-react-sample) + +## Development and Contributing + +Interested in contributing? We :heart: pull requests! See the [Contribution](CONTRIBUTING.md) guidelines. + +## Getting Help + +We love to hear from you so if you have questions, comments or find a bug in the project, let us know! You can either: + +- Open an issue on this repository +- See for support options +- Tweet at us! We're [@VonageDev](https://twitter.com/VonageDev) on Twitter +- Or [join the Vonage Developer Community Slack](https://developer.nexmo.com/community/slack) + +## Further Reading + +- Check out the Developer Documentation at \ No newline at end of file diff --git a/react-sample-app/README.md b/react-sample-app/README.md index 2483292..d7adbad 100644 --- a/react-sample-app/README.md +++ b/react-sample-app/README.md @@ -4,13 +4,14 @@ This document shows you how to prepare and run the sample application. The app is built using [Accelerator Core JS](https://github.com/opentok/accelerator-core-js) and the following accelerator packs: - - [Text Chat](https://www.npmjs.com/package/opentok-text-chat) - - [Screen Sharing](https://www.npmjs.com/package/opentok-screen-sharing) - - [Annotation](https://www.npmjs.com/package/opentok-annotation) +- [Text Chat](https://www.npmjs.com/package/opentok-text-chat) +- [Screen Sharing](https://www.npmjs.com/package/opentok-screen-sharing) +- [Annotation](https://www.npmjs.com/package/opentok-annotation) ### Configuration Add a `config.json` file with your OpenTok credentials to the `src` directory: + ```javascript { "apiKey": "YOUR_API_KEY", @@ -22,11 +23,12 @@ Add a `config.json` file with your OpenTok credentials to the `src` directory: ### Deploying and running the app This sample application was built with [Create React App](https://github.com/facebookincubator/create-react-app) and uses [webpack](https://webpack.github.io/) to transpile code. + ```javascript $ npm install $ npm run start ``` ----------- +--- *Looking for a sample in plain JavaScript? Click [here](https://github.com/opentok/accelerator-core-js/tree/master/vanilla-js-sample-app).* diff --git a/sdk-wrapper-react-sample/README.md b/sdk-wrapper-react-sample/README.md index 155a097..3b4bc5c 100644 --- a/sdk-wrapper-react-sample/README.md +++ b/sdk-wrapper-react-sample/README.md @@ -1,6 +1,7 @@ ## React Sample Application Add a `credentials.json` file with your OpenTok credentials to the `src` directory: + ```javascript { "apiKey": "YOUR_API_KEY", @@ -9,9 +10,9 @@ Add a `credentials.json` file with your OpenTok credentials to the `src` directo } ``` - To run: -```javascript -$ npm install -$ npm run start + +```bash +npm install +npm run start ``` diff --git a/vanilla-js-sample-app/README.md b/vanilla-js-sample-app/README.md index e27a807..5f7942c 100644 --- a/vanilla-js-sample-app/README.md +++ b/vanilla-js-sample-app/README.md @@ -1,6 +1,7 @@ ## JavaScript Sample Application Add your OpenTok credentials to the `options` hash in `app.js`: + ```javascript const options = { credentials: { @@ -12,8 +13,9 @@ credentials: { ``` To run: -```javascript -$ npm install -$ npm run build -$ node server.js + +```bash +npm install +npm run build +node server.js ```