Awesome
<p align="center"> <img alt="React Native Template Obytes" src="https://github.com/obytes/react-native-template-obytes/assets/11137944/a8163d23-897a-4efe-91ce-b9bf7348c18f" width="200" /> </p> <h1 align="center"> React Native Template Obytes </h1>
๐ฑ A template for your next React Native project ๐, Made with developer experience and performance first: Expo, TypeScript, TailwindCSS, Husky, Lint-Staged, expo-router, react-query, react-hook-form, I18n.
Welcome to the Obytes Mobile Tribe's Expo / React Native Starter Kit!
๐ Motivation
Our goal with this starter kit was to streamline the process of building React Native apps, both for our own team and for our clients. We wanted to create a resource that would allow us to create high-quality apps faster and with less effort, while ensuring that all of our projects adhere to the same code standards and architectural principles.
The benefits of using this starter kit are numerous. It helps our team easily switch between projects, as we can rely on a consistent foundation of code. It also allows us to focus on the business logic of each project rather than getting bogged down in boilerplate code. And, because it promotes consistency across projects, it makes it easier to maintain and scale our apps, as well as share code between teams.
Overall, our starter kit is designed to facilitate efficient and effective app development, helping us to bring the best possible products to our clients
โ๏ธ Philosophy
When creating this starter kit, we had several guiding principles in mind::
- ๐ Production-ready: We wanted to ensure that this starter was ready for real-world use, providing a solid foundation for building production-grade apps.
- ๐ฅท Developer experience and productivity: Our focus was on creating a starter that would enhance the developer experience and increase productivity.
- ๐งฉ Minimal code and dependencies: We aimed to keep the codebase and dependencies as small as possible.
- ๐ช Well-maintained third-party libraries: We included only well-maintained and reliable third-party libraries, to provide stability and support for our projects.
โญ Key Features
- โ Latest Expo SDK with Custom Dev Client: Leverage the best of the Expo ecosystem while maintaining full control over your app.
- ๐ TypeScript for enhanced code quality and bug prevention through static type checking.
- ๐ Minimal UI kit built with TailwindCSS, featuring common components essential for your app.
- โ๏ธ Multi-environment build support (Production, Staging, Development) using Expo configuration.
- ๐ฆ Husky for Git Hooks: Automate your git hooks and enforce code standards.
- ๐ก Clean project structure with Absolute Imports for easier code navigation and management.
- ๐ซ Lint-staged: Run Eslint and TypeScript checks on Git staged files to maintain code quality.
- ๐ VSCode recommended extensions, settings, and snippets for an enhanced developer experience.
- โ๏ธ Pre-installed Expo Router with examples for comprehensive app navigation.
- ๐ซ Auth flow implementation using Zustand for state management and react-native-mmkv for secure data storage.
- ๐ 10+ Github Actions workflows for building, releasing, testing, and distributing your app.
- ๐ฅ React Query and axios for efficient data fetching and state management.
- ๐งต Robust form handling with react-hook-form and zod for validation, plus keyboard handling.
- ๐ฏ Localization support with i18next, including Eslint for validation.
- ๐งช Unit testing setup with Jest and React Testing Library.
- ๐ E2E testing capabilities with Maestro for comprehensive app testing.
๐ค Is this starter for me?
Yes ๐
This starter kit is designed to benefit a wide range of React Native developers, from beginners to experienced professionals. Here's why it might be a good fit for you:
-
For beginners: It provides a solid foundation with best practices and common solutions, helping you learn industry-standard approaches to React Native development.
-
For experienced developers: It offers a well-structured, production-ready setup that can save you time and effort in project initialization and configuration.
-
For teams: It ensures consistency across projects and team members, making it easier to onboard new developers and maintain code quality.
-
For explorers: Even if you prefer not to use starter kits, this project can serve as a valuable reference. You can explore the codebase, documentation, and architectural decisions to gain insights and potentially adopt specific solutions for your own projects.
-
For learners: The starter kit incorporates up-to-date libraries and patterns, offering an opportunity to familiarize yourself with current best practices in the React Native ecosystem.
-
For AI-assisted development: This starter kit works well with AI coding tools. It provides a solid structure and best practices that can guide AI-generated code. This helps ensure that AI assistance leads to high-quality, maintainable code that fits well within your project.
Remember, you don't have to use the entire starter kit as-is. Feel free to cherry-pick ideas, configurations, or code snippets that align with your project needs. Whether you're building a new app from scratch or looking to improve your existing development process, this starter kit can provide valuable insights and practical solutions.
๐ Why Expo and not React Native CLI?
We have been using Expo as our main framework since the introduction of Continuous Native Generation (CNG) concept and we are happy with the experience.
I think this question is not valid anymore specially after the last React conference when the core react native team recommended using Expo for new projects.
"As of today, the only recommended community framework for React Native is Expo. Folks at Expo have been investing in the React Native ecosystem since the early days of React Native and as of today, we believe the developer experience offered by Expo is best in class." React native core team
Still hesitating? Check out this article or this video, maybe this one video too.
๐งโ๐ป Stay up to date
We are committed to continually improving our starter kit and providing the best possible resources for building React Native apps. To that end, we regularly add new features and fix any bugs that are discovered.
If you want to stay up to date with the latest developments in our starter kit, you can either watch the repository or hit the "star" button. This will allow you to receive notifications whenever new updates are available.
We value the feedback and contributions of our users, and we encourage you to let us know if you have any suggestions for improving our starter kit. We are always looking for ways to make it even more effective and useful for our community. So, please do not hesitate to reach out and share your thoughts with us.
<!-- add a gif image here -->๐ Libraries used
- Expo
- Expo Router
- Nativewind
- Flash list
- React Query
- Axios
- React Hook Form
- i18next
- zustand
- React Native MMKV
- React Native Gesture Handler
- React Native Reanimated
- React Native Svg
- React Error Boundaries
- Expo Image
- React Native Keyboard Controller
- Moti
- React Native Safe Area Context
- React Native Screens
- Tailwind Variants
- Zod
Contributors
This starter is maintained by Obytes mobile tribe team and we welcome new contributors to join us in improving it. If you are interested in getting involved in the project, please don't hesitate to open an issue or submit a pull request.
In addition to maintaining this starter kit, we are also available to work on custom projects and help you build your dream app. If you are looking for experienced and reliable developers to bring your app vision to life, please visit our website at obytes.com/contact to get in touch with us. We would be happy to discuss your project in more detail and explore how we can help you achieve your goals.
๐ฅ How to contribute?
Thank you for your interest in contributing to our project. Your involvement is greatly appreciated and we welcome your contributions. Here are some ways you can help us improve this project:
- Show your support for the project by giving it a ๐ on Github. This helps us increase visibility and attract more contributors.
- Share your thoughts and ideas with us by opening an issue. If you have any suggestions or feedback about any aspect of the project, we are always eager to hear from you and have a discussion.
- If you have any questions about the project, please don't hesitate to ask. Simply open an issue and our team will do our best to provide a helpful and informative response.
- If you encounter a bug or typo while using the starter kit or reading the documentation, we would be grateful if you could bring it to our attention. You can open an issue to report the issue, or even better, submit a pull request with a fix.
We value the input and contributions of our community and look forward to working with you to improve this project.
โ FAQ
If you have any questions about the starter and want answers, please check out the Discussions page.
๐ License
This project is MIT licensed.