Overview
Welcome to the Atlas Expo / React Native Starter Kit!
π Motivation
Section titled βπ MotivationβThe goal of this starter kit is to streamline the process of building React Native apps. It provides a resource for creating high-quality apps faster and with less effort, while ensuring projects adhere to consistent code standards and architectural principles.
The benefits of using this starter kit are numerous. It provides a consistent foundation that makes it easy to switch between projects and focus on business logic rather than boilerplate code. Because it promotes consistency, it makes apps easier to maintain and scale.
Overall, this starter kit is designed to facilitate efficient and effective app development, helping you bring the best possible products to your users.
βοΈ Philosophy
Section titled ββοΈ 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
Section titled ββ 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 Uniwind and HeroUI Native, 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?
Section titled βπ€ 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?
Section titled βπ 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
Section titled βπ§βπ» 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.
π Libraries used
Section titled βπ Libraries usedβ- Expo
- Expo Router
- Uniwind
- HeroUI Native
- 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
Section titled βContributorsβThis starter is maintained by Tuan Anh Le and I welcome new contributors to join in improving it. If youβre interested in getting involved, please donβt hesitate to open an issue or submit a pull request.
In addition to maintaining this starter kit, Iβm available for custom projects and consulting. If youβre looking for an experienced React Native developer to bring your app vision to life, please visit leanhtuan1994.github.io/contact to get in touch. Iβd be happy to discuss your project and explore how I can help you achieve your goals.
β FAQ
Section titled ββ FAQβIf you have any questions about the starter and want answers, please check out the Discussions page.