Skip to content

Commit eae34e8

Browse files
committed
docs: fix links
1 parent 8890932 commit eae34e8

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Welcome to `react-native-template` 👋, the go-to template for building mobile
3737
8. [Finish Line](#finish-line)
3838

3939
<a name="quick-start"></a>
40+
4041
## Quick Start 🚀
4142

4243
To create a new project using this template, run:
@@ -48,6 +49,7 @@ yarn
4849
```
4950

5051
<a name="project-structure"></a>
52+
5153
## Project Structure 🏗️
5254

5355
This template provides a well-organized directory structure with a set of pre-configured files to streamline your development process. Here's an overview of the essential components:
@@ -60,6 +62,7 @@ This template provides a well-organized directory structure with a set of pre-co
6062
- `utils`: A place for utility functions, hooks, stores and types that can be shared across your application.
6163

6264
<a name="configuration-files"></a>
65+
6366
## Configuration Files 📑
6467

6568
Each configuration file is set up to ensure that your development experience is as smooth as possible:
@@ -80,10 +83,12 @@ Each configuration file is set up to ensure that your development experience is
8083
- `yarn.lock`: Auto-generated file that ensures consistent installation of node modules across environments.
8184

8285
<a name="configuration-files"></a>
86+
8387
## Features and Benefits 🌟
8488

8589
This template comes equipped with a robust set of features and solutions to enhance your development workflow:
8690

91+
<a name="1-full-linting-and-auto-formatting"></a>
8792
### 1. Full Linting and Auto Formatting 🛠️
8893

8994
Leverage full linting and auto-formatting with ESLint and Prettier, configured to help maintain a clean and consistent codebase. Auto-sorting of imports and Tailwind classes on save, alongside the enforcement of good practices, keeps your project tidy.
@@ -98,6 +103,8 @@ For linting and formatting your code, use these commands in `package.json`:
98103
}
99104
```
100105

106+
<a name="2-easy-aliases-with-typescript"></a>
107+
101108
### 2. Easy Aliases with TypeScript 🏷️
102109

103110
Clean up your imports with straightforward path aliases in `tsconfig.json`, promoting a more organized code structure.
@@ -115,6 +122,8 @@ Clean up your imports with straightforward path aliases in `tsconfig.json`, prom
115122
}
116123
```
117124

125+
<a name="3-nativewind-integration"></a>
126+
118127
### 3. Nativewind Integration 🎨
119128

120129
Hit the ground running with Nativewind's setup. Utilize the `theme` object for consistent styling and the `cn` function to conditionally apply classes.
@@ -132,6 +141,8 @@ import { cn } from '@utils/cn';
132141
</Text>
133142
```
134143

144+
<a name="4-full-localization-support"></a>
145+
135146
### 4. Full Localization Support 🌐
136147

137148
Achieve effortless internationalization with `react-i18next` and `i18next`. Translation keys are typesafe and localisation files are neatly organized.
@@ -144,6 +155,8 @@ i18n.changeLanguage('en'); // Switch languages
144155
<Text>{t('helloWorld')}</Text>; // Typesafe keys
145156
```
146157

158+
<a name="5-typed-expo-router-setup"></a>
159+
147160
### 5. Typed Expo Router Setup 🚦
148161

149162
Pre-configured routing structure for authenticated and guest users. Routes are typed for hassle-free navigation.
@@ -171,6 +184,8 @@ export default Routes;
171184
// router.push(Routes.artists.artist('1').songs.song('2'));
172185
```
173186

187+
<a name="6-zodius-api-client-setup"></a>
188+
174189
### 6. Zodius API Client Setup 📡
175190

176191
A pre-configured Zodius API client with Tenstack Query for managing API calls. The `./api` folder includes a fully set up example for GET and POST requests, complete with schemas, definitions, and global error handling through a custom Zodius plugin.
@@ -195,6 +210,8 @@ const api = new ZodiosHooks('exampleApi', apiClient);
195210
export { api, apiClient };
196211
```
197212

213+
<a name="7-custom-utility-hooks"></a>
214+
198215
### 7. Custom Utility Hooks 🔗
199216

200217
Two custom hooks are provided for enhanced functionality:
@@ -215,6 +232,8 @@ const [fontsLoaded, fontError] = useCustomFonts({
215232
const isOnline = useIsOnline();
216233
```
217234

235+
<a name="8-zustand-state-management"></a>
236+
218237
### 8. Zustand State Management 🏪
219238

220239
Effortlessly manage your application state with Zustand, which includes async persistent storage support.
@@ -223,6 +242,8 @@ Effortlessly manage your application state with Zustand, which includes async pe
223242
const { value, increment, decrement } = useExampleStore();
224243
```
225244

245+
<a name="9-cicd-workflow-configuration"></a>
246+
226247
### 9. CI/CD Workflow Configuration 🔄
227248

228249
Automate your development processes with pre-defined GitHub Actions workflows located in the `.github` folder:
@@ -231,20 +252,30 @@ Automate your development processes with pre-defined GitHub Actions workflows lo
231252
- `lint.yml`: For code linting checks.
232253
- A pull request template to standardize contributions.
233254

255+
<a name="10-infisical-environment-variable-support"></a>
256+
234257
### 10. Infisical Environment Variable Support 🔐
235258

236259
Incorporate environment variables securely using the Infisical service with a custom script `infisical.sh`, which is run to inject variables into your build process.
237260

261+
<a name="included-packages-and-their-benefits"></a>
262+
238263
### Included Packages and Their Benefits 📦
239264

240265
The `react-native-template` includes several packages that extend its capabilities and enrich the development experience. Here’s a brief overview of these packages and what they offer:
241266

267+
<a name="zod"></a>
268+
242269
#### Zod
243270
[Zod](https://github.com/colinhacks/zod) is a TypeScript-first schema declaration and validation library. It allows you to build schemas using TypeScript syntax, ensuring that data conforms to the specified shapes and types at runtime. Zod is particularly useful for validating data received from external sources, such as APIs or user input, and helps enforce type safety throughout the application.
244271

272+
<a name="lottie-react-native"></a>
273+
245274
#### Lottie-React-Native
246275
[Lottie-React-Native](https://github.com/lottie-react-native/lottie-react-native) is a mobile library for React Native that parses Adobe After Effects animations exported as json with Bodymovin and renders them natively on mobile. This package enables developers to add high-quality animations to their React Native applications easily. Lottie animations are highly performant and can drastically enhance the user interface by providing fluid, eye-catching animations that can be controlled programmatically.
247276

277+
<a name="lucide-react-native"></a>
278+
248279
#### Lucide-React-Native
249280
[Lucide-React-Native](https://github.com/lucide-icons/lucide-react-native) is a fork of the Feather Icons project, specifically tailored for React Native applications. It provides a collection of beautifully crafted, customizable icons which are easy to use in UI development. Using Lucide icons helps maintain consistency and clarity in the app’s design, making the interface more intuitive and visually appealing.
250281

0 commit comments

Comments
 (0)