@binarapps/baca-react-native-template

BACA - React Native Template

BACA - BINAR APPS CORE APPLICATION

This repository is part of a whole ecosystem, and it only contains React Native code.

🔗 Quick Links

• Documentation:
  • Detailed guides on bootstrapping, building, and deploying your app.
• Demo:
  • Check out the live web demo of the template.
• Video
  • See quick preview on how it looks
• Examples:
  • Explore example implementations and use cases.
• BinarApps Company:
  • Learn more about the team behind BACA.

📚 Table of Contents

• 🎉 Great React Native Boilerplate
• 📖 Documentation
• 🏆 Why Use BACA?
• 🔍 Preview
• 🚀 How to Use?
  • 🏃‍♂️ Quick Steps
• 🛠 Prerequisites
• 📦 What's Inside?
  • Libraries and Tools
• 🔜 Future Plans
• 👏 How to Contribute
  • Steps to Contribute
• 🤙 How to Run Locally
  • Environment Variables Setup
• 📘 License
• 📝 Feedback
• 👨‍👩‍👧‍👦 Contributors
• 📦 Similar Packages

🎉 Great React Native Boilerplate

This is a template for React Native and Expo. It includes all the necessary components to start working with the Expo framework. It has the most popular packages included, making it easier to start coding the app itself without the usual boilerplate setup.

📖 Documentation

Check out our documentation page. It contains:

• Bootstrapping the project
  • Tutorial on easy setup from scratch
• Building the app
• Deploying the app
• Tutorials on:
  • Managing environment variables
  • Using Jotai as a state management tool
  • And many more tutorials

🏆 Why Use BACA?

BACA is designed to save you time and effort by providing a robust, production-ready template for React Native and Expo. Here's why you should choose BACA:

• Works seamlessly with EXPO GO
  • Ideal for starting a project; switch to expo-dev-client later.
• Supports Web
  • Perfect for developing apps for both web and mobile platforms.
• Code Generators
  • Easily create new screens, components, and more.
• Fully Typed
  • Ensures robust code quality.
• Comprehensive App Deployment Documentation
• New architecture
  • Works on new architecture of react native

🚀 How to Use?

We have prepared detailed documentation on how to run the project with this template - Bootstrap docs.

It's great for production projects, but if you want to just test it, you can follow these quick steps:

🏃‍♂️ Quick Steps

npx create-expo-app --template=@binarapps/baca-react-native-template name_of_your_app
cd name_of_your_app
yarn bootstrap

# The CLI will ask you some questions about your app (you can fill in this data later).

🛠 Prerequisites

Ensure you have the following installed before you begin:

• Node.js (v18+)
• Expo CLI
• yarn

Ideally it would be good to have finished React Native Environment setup, check how to do it here

📦 What's Inside?

Libraries and Tools

• TypeScript: Strictly typed code for enhanced development experience.
• Expo v52: The latest Expo framework with modern React Native features.
• Prettier and Eslint: Automatically format and lint your code.
• Babel-Module-Resolver: Unified imports.
• Jest and @testing-library/react-native: Unit tests for React Native components.
• i18next: Simplifies internationalization and language support.
• Axios + React Query: Optimized data fetching and state management.
• Jotai: Minimalistic state management library.
• Reanimated & Moti: Smooth animations.
• Reactotron: Debugging and monitoring React Native apps.
• Expo-Notifications: Ready-to-use push notification handling.
• Custom CLI: yarn baca to access available options.

🔜 Future Plans

• Tutorials on using features like navigation, deep linking, theming and auth flows.
• Add the ability to easily switch backend services.
• Integrate Figma designs for a more cohesive UI/UX experience.
• Regular updates to Expo versions.
• Enhance documentation for App Store and Play Store deployment.
• Improve mock server logic.
• Add commit lint for consistent commits.
• Add support for libraries like expo-image, FlashList, and ZOD.
• Todos
  • Home screen
    • Add scripts - yarn g / yarn b
    • Add link to docs
    • Add link to examples
  • Settings screen redesign
  • finish ui docs

👏 How to Contribute

Contributions are always welcome!

Steps to Contribute

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your-feature).
3. Make your changes.
4. Run tests (yarn test) to ensure everything works.
5. Submit a pull request.

Please refer to CONTRIBUTING.md for more details on contributing.

🤙 How to Run Locally

Clone the project:

git clone https://github.com/binarapps/baca-react-native-template.git

Go to the project directory:

cd baca-react-native-template

Install dependencies:

yarn

Start the Expo server:

yarn start

Environment Variables Setup

1. Create an empty file scripts/doppler_variables.sh and add the following script:

export DOPPLER_TOKEN_DEVELOPMENT=dp.st.alpha.XXXXxxxxXXXXxxxxXXXXxxxx

2. Run yarn prepare:env_file to generate the environment variables template.

3. Add the correct values to scripts/doppler_variables.sh (ask a developer if needed).

📘 License

This project is licensed under the MIT License.

📝 Feedback

If you have any feedback, please reach out to Mateusz Rostkowski.

👨‍👩‍👧‍👦 Contributors

• Kacper Grzeszczyk - @kacgrzes
• Mateusz Rostkowski - @MateuszRostkowski
• Michał Szalowski - @MSzalowski
• Jakub Zagórski - @zagoorland
• Łukasz Patalan - @lukasz
• Mario Gliwa - @mario688
• Michał Baumruck - @micbaumr
• Andrzej Zaborski - @AnMiZa
• Bartłomiej Sworzeń - @Sworzen1
• Karol Andracki - @karol-andracki
• Weronika Grzeszczyk - @vercia
• Mateusz Świerczyński - @MatiSwierczynski

📦 Similar Packages

• Maintained:
  • react-native-template-obytes
  • ignite
  • react-native-boilerplate
  • start-ui
• Outdated:
  • expo-typescript-template
  • react-native-expo-template
  • react-native-starter
  • react-native-expo-starter-kit