Welcome to the TwikkL app! This app provides live-streaming, video recording, sharing services, and supports the mobile development community in learning.
If you have any experience and would like to support us or share your point of view, or if you are a beginner with questions, feel free to join the Discussions.
Check out the following animated image for a demo of the latest version of the app:
Expand 👈
Before you start, make sure you have at least ~15 minutes to set up your development environment.
The most important technologies used in this app are:
- React v18
- React Native v0.71
- React Native CLI (Command Line Interface)
- React Native Paper v5 (UI library)
If you are not familiar with some of these technologies, don't worry. However, we recommend you to learn the basics. You can start by following the React Native basics guide.
To begin, ensure that the following tools are installed on your local machine:
- Node.js (We recommend LTS version higher than v16)
- A JavaScript IDE such as VS Code, WebStorm, etc.
- Git (Refer to GitHub's guide on how to set up Git)
Once you're ready with the mentioned tools, follow these steps to import the source code:
git clone https://github.com/JiggyDevs/twikkl-app.git
- Next, navigate to the project directory and install the dependencies using npm:
cd twikkl-app
npm install
To run the app on an Android emulator or connected device, use the following command:
npx react-native run-android
To run the app on an iOS simulator or connected device, use the following command:
npx react-native run-ios
The styling integration must follow the design prototype, which is currently exposed as a few examples under the /docs folder.
If you are interested in viewing all the design examples, you can access our Figma link by creating a free account.
Also, note the theme setup in the theme.ts file, which follows the React Native Paper theming guide.
Finally, for icons, we recommend following the React Native Vector Icons library.
Please see the contributing guide for detailed instructions on how to get started with us. We accept any sort of help that can make this project better, even a word like "Good luck!" 😍.