https://github.com/yazaldefilimone/clean-arch-react-native-starter

Clean architecture starter for React Native with TailwindCSS, Jest, TypeScript. All the tools you need to build your mobile application.
https://github.com/yazaldefilimone/clean-arch-react-native-starter

boilerplate clean-architecture clean-code jest mobile react-native react-navigation tdd test-driven-development test-library typescript

Last synced: 3 months ago
JSON representation

Clean architecture starter for React Native with TailwindCSS, Jest, TypeScript. All the tools you need to build your mobile application.

• Host: GitHub
• URL: https://github.com/yazaldefilimone/clean-arch-react-native-starter
• Owner: yazaldefilimone
• Created: 2022-12-24T16:47:06.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-04-08T04:07:16.000Z (almost 2 years ago)
• Last Synced: 2024-09-16T10:45:46.481Z (4 months ago)
• Topics: boilerplate, clean-architecture, clean-code, jest, mobile, react-native, react-navigation, tdd, test-driven-development, test-library, typescript
• Language: TypeScript
• Homepage:
• Size: 2.35 MB
• Stars: 7
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
 


  

  

  

  

  





Clean architecture starter for React Native with TailwindCSS, Jest, TypeScript. 


All the tools you need to build your mobile application. 



## Features

- ⚡️ Expo 47.0.9

- ⚛️ React 18.1.0

- ⛑ TypeScript

- ✨ TailwindCSS 3.2.4 - CssInJs for component styling

- ✨ NativeWind 2.0.11 - Suporte by TailwindCSS in ReactNative

- 📏 TSLint — To find and fix problems in your code

- 💖 Prettier — Code Formatter for consistent style

- ⚙️ EditorConfig - Consistent coding styles across editors and IDEs

- 🗂 Path Mapping — Import components or images using the `~/` prefix

- ‽ Either Error Handler - For error handling. (Either is designed to hold either a left or a right value but never both).

## Quick Start

The best way to start with this template is using [create-expo-app](https://docs.expo.dev/get-started/create-a-new-app/).

```

# npx

npx create-expo-app --template clean-arch-react-native-starter

```

### Development

To start the project locally, run:

```bash

  npm start

  our

  yarn start

```

Open `http://localhost:{port}` with your browser to see the result or scan qr code or open in device machine.

### Requirements

- Node.js >= 12.22.0

- npm our yarn

### Directory Structure

- [`public`](./public) — Static assets such as images


- [`src`](./src) — Application source code, including screens, components, scripts.


- [`tests`](./tests) — Application test source code.


### Scripts

- `yarn/npm android`

- `yarn/npm ios`

- `yarn/npm start`

- `yarn/npm test`

- `yarn/npm test:watch`

- `yarn/npm test:ci`

### Path Mapping

TypeScript are pre-configured with custom path mappings. To import components or files, use the `~/` prefix.

```tsx

import { Button } from '~/infrastructure/ui/components/button';

// To import images or other files from the public folder

import avatar from '~/public/avatar.png';

```



## License

[MIT](https://github.com/yazaldefilimonepinto/clean-arch-react-native-starter/blob/main/LICENSE) © [Yazalde Filimone](https://www.linkedin.com/in/yazalde-filimone/)