Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/developer-sumit/react-native-lab

React Native CLI Setup is a npm package that automates the setup of your React Native development environment, including essential installations and project initialization.
https://github.com/developer-sumit/react-native-lab

npm npm-package react-native react-native-app react-native-cli react-native-jdk-setup react-native-package react-native-setup react-native-web reactnative

Last synced: 2 months ago
JSON representation

React Native CLI Setup is a npm package that automates the setup of your React Native development environment, including essential installations and project initialization.

Awesome Lists containing this project

README

        

React Native Lab

![Github License](./images/banner.jpg)

![Github License](https://img.shields.io/github/license/developer-sumit/react-native-lab)

**GITHUB** \
![Github Version](https://img.shields.io/github/package-json/v/developer-sumit/react-native-lab)
![Github Repo Created At](https://img.shields.io/github/created-at/developer-sumit/react-native-lab)
![Github Repo Contributors](https://img.shields.io/github/contributors/developer-sumit/react-native-lab)
![Github Repo Fork](https://img.shields.io/github/forks/developer-sumit/react-native-lab)

**NPM** \
![NPM Package Version](https://img.shields.io/npm/v/react-native-lab)
![NPM Package Last Updated](https://img.shields.io/npm/last-update/react-native-lab)
![NPM Package Downloads](https://img.shields.io/npm/d18m/react-native-lab)

`react-native-lab` is a cli tool to set up a React Native project with some pre-defined configurations. This tool helps you quickly set up a React Native development environment, including installing necessary dependencies like JDK, Android Studio.

This project is inspired by the simplicity and effectiveness of [create-next-app](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).

Table of Contents

- 🚀 [Features](#features)
- 📸 [Screenshots](#screenshots)
- ⚙️ [Prerequisites](#prerequisites)
- 🏁 [Getting Started](#getting-started)
- 🛠️ [Common Issues](#common-issues)
- 🆘 [Getting Help](#getting-help)
- 🤝 [Contributing](#contributing)
- 📜 [License](#license)

🚀 Features

- **Installs JDK (OpenJDK)**: Automatically installs the necessary JDK for Android development.
- **Installs Android Studio**: Sets up Android Studio, including the necessary SDKs and tools.
- **Sets Environment Variables**: Configures system environment variables such as `ANDROID_HOME`, `ANDROID_SDK_ROOT`, and `JAVA_HOME`.
- **Pre-built Templates**: Choose from a variety of pre-built templates to kickstart your React Native project.
- **Customizable Configuration**: Allows you to customize the project setup according to your preferences.
- **Cross-Platform Support**: Works on Windows, macOS, and Linux.
- **Environment Setup**: Optionally sets up a `.env` file for managing environment variables.
- **Navigation Setup**: Optionally sets up React Navigation in your project.
- **Alias Configuration**: Configures path aliases for cleaner and more manageable imports.

📸 Screenshots

Here are the available templates you can use with `react-native-lab`:

![Setup](./images/setup-1.png)
![Setup](./images/setup-2.png)



Blank Template


Blank Template


Navigation Template


Navigation Template

⚙️ Prerequisites

- Node.js (v14 or higher)
- npm (v6 or higher)

🏁 Getting Started

To get started with `react-native-lab`, follow these steps:

1. Ensure you have all the prerequisites installed on your system.
2. You can use `npx` to run the tool without installing it:
```sh
npx react-native-lab@latest
```

🛠️ Common Issues

- **Installation Errors**: Ensure you have the correct versions of Node.js and npm installed. Try clearing the npm cache:
```sh
npm cache clean --force
```
- **Permission Errors**: Run the command with elevated privileges (e.g., using `sudo` on macOS/Linux or running the terminal as an administrator on Windows).

🆘 Getting Help

If you need further assistance, you can:

- Check the [GitHub Issues](https://github.com/developer-sumit/react-native-lab/issues) for similar problems.
- Open a new issue with detailed information about your problem.
- Reach out to the community for support.

By following these steps, you should be able to resolve most issues and get your React Native project up and running smoothly.

🤝 Contributing

Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request.

To contribute:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature`).
3. Make your changes.
4. Commit your changes (`git commit -m 'Add some feature'`).
5. Push to the branch (`git push origin feature`).
6. Open a pull request.

Please make sure to follow the project's coding guidelines and standards.

📜 License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.