burn - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #llm #go #machine-learning #deep-learning #windows #awesome #cli #kubernetes #mcp #ios #openai #open-source

burn

(★ 118)

:fire: BURN a React Native boilerplate

File Explorer

Download Latest Version (.zip)

- settings.json
- - BUCK
  - build.gradle
  - proguard-rules.pro
- - BUCK
  - debug.keystore.properties
- build.gradle
- gradle.properties
- gradlew
- gradlew.bat
- settings.gradle
- config.json
- init.js
- play.spec.js
- - AppDelegate.h
  - AppDelegate.m
  - Info.plist
  - main.m
- - Info.plist
- - Info.plist
- - project.pbxproj
- - burnTests.m
  - Info.plist
- setup.js
- - background.png
- - store.js
- - Home.js
  - index.js
.babelrc
.buckconfig
.eslintrc
.flowconfig
.gitattributes
.gitignore
.prettierrc
.watchmanconfig
App.js
app.json
docz.png
doczrc.js
icon.png
index.js
package.json
README.md
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/FotonTech/burn

Downloads the entire project code from GitHub to your computer.

cd burn

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java/Kotlin projects.
Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.

cd android/app

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

✅ A BUILD SUCCESSFUL message means it worked. The output is created under build/.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# BURN

<img src="./icon.png" />

A

- Redux
- Redux-Thunk
- React-Navigation
- Animatable
- Jest(Unit tests)
- Flow(Type checking)
- Detox(e2e tests)
- Docz(Styleguide)
- Styled components
- Eslint
- Prettier

React Native boilerplate

## Glossary

- [Overview](#overview)
- [Installation](#installation)
- [Usage](#usage)
  - [Styleguide](#styleguide)
  - [Testing](#testing)
  - [Prettier](#prettier)
  - [Pre-commit hook](#pre-commit)

---

## Overview

Welcome to Burn react-native boilerplate

## Installation

Feel free to fork or clone this project and run

```yarn install```

then

```yarn ios```

And there you go!

## Styleguide

For the project Styleguide we will go for the best option: Docz

### Docz
To run Docz simply:
```yarn docz dev```
<img src="./docz.png" />

## Testing

#### Flow

To run Flow on the project, you can easily use already prepared scripts from `package.json` file and run

```yarn flow```

This starts Flow server and executes Flow checks. To stop Flow server, you can execute:

```yarn flow-stop```

More on Flow you can find [here](https://flow.org/en/docs/).

#### ESLint

To check styling and other ESLint rules defined in `.eslintrc` file, it's enough to run:

```yarn lint```

#### Jest Unit tests

There is a script prepared to run all the unit tests defined with the use of Jest. Just run:

```yarn test:unit```

#### Detox e2e tests

There is a script prepared to run all the e2e test which plays the entire game and restarts the app

First you have to build it:
```yarn test:e2e:build```

Now, just run the test:
```yarn test:e2e```

---

### Prettier

[Prettier](https://github.com/prettier/prettier) is formatting all code

```yarn pretty```

---

### Pre-commit

This project comes with already prepared `precommit` hook, that runs prettier on  code and then executes unit tests, just before the commit. This will prevent you from committing badly styled or invalid code to the repo.

Precommit is defined in `package.json`'s `scripts` section and is taking advantage of a package called `lint-staged`. You can find more info on it [here](https://github.com/okonet/lint-staged).