Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ixartz/react-native-boilerplate

๐Ÿš€๐ŸŽ‰๐Ÿ“š Boilerplate and Starter for React Native, Expo, NativeWind and TypeScript โšก๏ธ Made with developer experience first: React Native + Expo + TypeScript + ESLint + Prettier + Husky + Lint-Staged + Jest + Detox + VSCode + NativeWind
https://github.com/ixartz/react-native-boilerplate

boilerplate boilerplate-template boilerplates detox eslint expo javascript jest mobile-development prettier react-native reactjs saas saas-boilerplate starter starter-kit starter-template tailwindcss templates typescript

Last synced: about 3 hours ago
JSON representation

๐Ÿš€๐ŸŽ‰๐Ÿ“š Boilerplate and Starter for React Native, Expo, NativeWind and TypeScript โšก๏ธ Made with developer experience first: React Native + Expo + TypeScript + ESLint + Prettier + Husky + Lint-Staged + Jest + Detox + VSCode + NativeWind

Awesome Lists containing this project

README

        

# Boilerplate and Starter for React Native, Expo, NativeWind and TypeScript [![Twitter](https://img.shields.io/twitter/url/https/twitter.com/cloudposse.svg?style=social&label=Follow%20%40Ixartz)](https://twitter.com/ixartz)


React Native Starter Template

๐Ÿš€ Boilerplate and Starter for React Native, Expo, NativeWind and TypeScript โšก๏ธ Made with developer experience first: React Native, Expo, TypeScript, ESLint, Prettier, Husky, Lint-Staged, Jest, Detox, VSCode, NativeWind.

### Features

Developer experience first:

- โšก [Expo](https://expo.dev) for mobile development
- โš›๏ธ [React Native](https://reactnative.dev) for building native apps using React
- ๐Ÿ”ฅ Type checking [TypeScript](https://www.typescriptlang.org)
- ๐Ÿ’Ž Integrate with [NativeWind](https://www.nativewind.dev), Tailwind CSS for React Native
- ๐Ÿ“ File-based routing with Expo Router
- ๐Ÿ“ Linter with [ESLint](https://eslint.org)
- ๐Ÿ’– Code Formatter with [Prettier](https://prettier.io)
- ๐ŸฆŠ Husky for Git Hooks
- ๐Ÿšซ Lint-staged for running linters on Git staged files
- ๐Ÿฆบ Unit Testing with Jest and React Testing Library
- ๐Ÿงช E2E Testing with Detox
- ๐Ÿ’ก Absolute Imports using `@` prefix
- ๐Ÿ—‚ VSCode configuration: Settings, Tasks and extension for PostCSS, ESLint, Prettier, TypeScript, Jest

### Nextless.js SaaS Boilerplate

Build your SaaS product faster with [React SaaS Boilerplate](https://nextlessjs.com).

[![React SaaS Boilerplate Next.js](https://creativedesignsguru.com/assets/images/themes/next-js-saas-starter-kit.jpg)](https://nextlessjs.com)

### Requirements

- Node.js 14+ and npm
- [iOS Simulator](https://docs.expo.dev/workflow/ios-simulator/)
- [Android Studio Emulator](https://docs.expo.dev/workflow/android-studio-emulator/)

### Getting started

Run the following command on your local environment:

```shell
git clone --depth=1 https://github.com/ixartz/React-Native-Boilerplate.git my-project-name
cd my-project-name
npm install
```

Then, you can run locally in development mode with live reload:

```shell
npm run dev:ios
# Or
npm run dev:android
```

This will open the app in the iOS simulator or Android emulator.

### Testing

Testing is an important part of the development process and often the neglected one. This starter code comes up with Jest and React Testing Library for unit testing and Detox for E2E testing.

#### Unit Testing

To run the unit tests, run the following command:

```shell
npm run test
```

#### E2E Testing

To run the E2E tests, you first need to run the following command:

```shell
npm run e2e:prepare # Only need to run once
```

Then, you can run the following command to run the E2E tests:

```shell
npm run e2e:ios
# Or
npm run e2e:android
```

### VSCode information (optional)

If you are VSCode users, you can have a better integration with VSCode by installing the suggested extension in `.vscode/extension.json`. The starter code comes up with Settings for a seamless integration with VSCode. The Debug configuration is also provided for frontend and backend debugging experience.

With the plugins installed on your VSCode, ESLint and Prettier can automatically fix the code and show you the errors. Same goes for testing, you can install VSCode Jest extension to automatically run your tests and it also show the code coverage in context.

Pro tips: if you need a project wide type checking with TypeScript, you can run a build with Cmd + Shift + B on Mac.

### Contributions

Everyone is welcome to contribute to this project. Feel free to open an issue if you have question or found a bug. Totally open to any suggestions and improvements.

### License

Licensed under the MIT License, Copyright ยฉ 2023

See [LICENSE](LICENSE) for more information.

---

Made with โ™ฅ by [CreativeDesignsGuru](https://creativedesignsguru.com) [![Twitter](https://img.shields.io/twitter/url/https/twitter.com/cloudposse.svg?style=social&label=Follow%20%40Ixartz)](https://twitter.com/ixartz)

[![React SaaS Boilerplate](https://creativedesignsguru.com/assets/images/themes/next-js-saas-starter-kit.jpg)](https://nextlessjs.com)