|
| 1 | +# React Native CLI Setup |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | + |
| 6 | +`react-native-cli-setup` is a npm package 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, and the React Native CLI. |
| 7 | + |
| 8 | +## Table of Contents |
| 9 | + |
| 10 | +- 🚀 [Features](#features) |
| 11 | +- ⚙️ [Prerequisites](#prerequisites) |
| 12 | +- 🏁 [Getting Started](#getting-started) |
| 13 | +- 🛠️ [Common Issues](#common-issues) |
| 14 | +- 🤝 [Contributing](#contributing) |
| 15 | +- 📜 [License](#license) |
| 16 | + |
| 17 | +## Features |
| 18 | + |
| 19 | +- Installs JDK (OpenJDK) |
| 20 | +- Installs Android Studio |
| 21 | +- Installs React Native CLI |
| 22 | +- Adds system environment variables - ANDROID_HOME, ANDROID_SDK_ROOT, JAVA_HOME |
| 23 | +- Initializes a new React Native project |
| 24 | + |
| 25 | +## Prerequisites |
| 26 | + |
| 27 | +- Node.js (v14 or higher) |
| 28 | +- npm (v6 or higher) |
| 29 | +- Windows operating system |
| 30 | + |
| 31 | +## Getting Started |
| 32 | + |
| 33 | +To get started with `react-native-cli-setup`, follow these steps: |
| 34 | + |
| 35 | +1. Ensure you have all the prerequisites installed on your system. |
| 36 | +2. You can use `npx` to run the tool without installing it: |
| 37 | + ```sh |
| 38 | + npx react-native-cli-setup |
| 39 | + ``` |
| 40 | + |
| 41 | +### Common Issues |
| 42 | + |
| 43 | +- **Installation Errors**: Ensure you have the correct versions of Node.js and npm installed. Try clearing the npm cache: |
| 44 | + ```sh |
| 45 | + npm cache clean --force |
| 46 | + ``` |
| 47 | +- **Permission Errors**: Run the command with elevated privileges (e.g., using `sudo` on macOS/Linux or running the terminal as an administrator on Windows). |
| 48 | + |
| 49 | +### Getting Help |
| 50 | + |
| 51 | +If you need further assistance, you can: |
| 52 | + |
| 53 | +- Check the [GitHub Issues](https://github.com/developer-sumit/react-native-cli-setup/issues) for similar problems. |
| 54 | +- Open a new issue with detailed information about your problem. |
| 55 | +- Reach out to the community for support. |
| 56 | + |
| 57 | +By following these steps, you should be able to resolve most issues and get your React Native project up and running smoothly. |
| 58 | + |
| 59 | +## Contributing |
| 60 | + |
| 61 | +Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request. |
| 62 | + |
| 63 | +To contribute: |
| 64 | + |
| 65 | +1. Fork the repository. |
| 66 | +2. Create a new branch (`git checkout -b feature`). |
| 67 | +3. Make your changes. |
| 68 | +4. Commit your changes (`git commit -m 'Add some feature'`). |
| 69 | +5. Push to the branch (`git push origin feature`). |
| 70 | +6. Open a pull request. |
| 71 | + |
| 72 | +Please make sure to follow the project's coding guidelines and standards. |
| 73 | + |
| 74 | +## License |
| 75 | + |
| 76 | +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. |
0 commit comments