web-client

OwnTube.tv 📺, a portable video client for PeerTube in React Native.

Technologies that we depend upon:

• Expo
• React
• React Native
• TypeScript

Contributing

Review existing issues to see if there's an open item to contribute to, or add a new one. If you identify bugs, please report them in a reproducible manner with all details upfront. We use the Forking workflow to collaborate.

Development

Open your fork in GitHub Codespaces for developing and testing the code.

cd OwnTube.tv/
npm install
npm run web

To get Continuous Delivery from main branch working with GitHub Pages, open your fork "Settings" > "Pages" > "Build and deployment" and select "Source: GitHub Actions", then go to your fork "Actions" tab and select "I understand my workflows, go ahead and enable them".

When a improvement is ready to be contributed in a pull request, please review the following checklist:

1. Squash your changes into a single clear and thoroughly descriptive commit, split changes into multiple commits only when it contributes to readability
2. Reference the GitHub issue that you are contributing on in your commit title or body
3. Sign your commits, as this is required by the automated GitHub PR checks
4. Ensure that the changes adhere to the project code style and formatting rules by running npx eslint . and npx prettier --check ../ from the ./OwnTube.tv/ directory (without errors/warnings)
5. Include links and illustrations in your pull request to make it easy to review
6. Request a review by @mykhailodanilenko, @ar9708, and @mblomdahl

Architecture

Refer to the architecture documentation for additional information.