Skip to content

Commit 390af90

Browse files
Update README.md for improved section formatting and add 'Getting Help' section; update package versions and remove unused dependency
1 parent 2a46659 commit 390af90

File tree

4 files changed

+17
-35
lines changed

4 files changed

+17
-35
lines changed

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,28 +17,29 @@
1717

1818
## Table of Contents
1919

20-
- 🚀 [Features](#features)
21-
- ⚙️ [Prerequisites](#prerequisites)
22-
- 🏁 [Getting Started](#getting-started)
23-
- 🛠️ [Common Issues](#common-issues)
24-
- 🤝 [Contributing](#contributing)
25-
- 📜 [License](#license)
20+
- 🚀 [Features](#🚀-features)
21+
- ⚙️ [Prerequisites](#⚙️-prerequisites)
22+
- 🏁 [Getting Started](#🏁-getting-started)
23+
- 🛠️ [Common Issues](#🛠️-common-issues)
24+
- 🆘 [Getting Help](#🆘-getting-help)
25+
- 🤝 [Contributing](#🤝-contributing)
26+
- 📜 [License](#📜-license)
2627

27-
## Features
28+
## 🚀 Features
2829

2930
- Installs JDK (OpenJDK)
3031
- Installs Android Studio
3132
- Installs React Native CLI
3233
- Adds system environment variables - ANDROID_HOME, ANDROID_SDK_ROOT, JAVA_HOME
3334
- Initializes a new React Native project
3435

35-
## Prerequisites
36+
## ⚙️ Prerequisites
3637

3738
- Node.js (v14 or higher)
3839
- npm (v6 or higher)
3940
- Windows operating system
4041

41-
## Getting Started
42+
## 🏁 Getting Started
4243

4344
To get started with `react-native-cli-setup`, follow these steps:
4445

@@ -48,15 +49,15 @@ To get started with `react-native-cli-setup`, follow these steps:
4849
npx react-native-cli-setup
4950
```
5051

51-
### Common Issues
52+
## 🛠️ Common Issues
5253

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

59-
### Getting Help
60+
## 🆘 Getting Help
6061

6162
If you need further assistance, you can:
6263

@@ -66,7 +67,7 @@ If you need further assistance, you can:
6667

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

69-
## Contributing
70+
## 🤝 Contributing
7071

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

@@ -81,6 +82,6 @@ To contribute:
8182

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

84-
## License
85+
## 📜 License
8586

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

package-lock.json

Lines changed: 2 additions & 15 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-native-cli-setup",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"type": "module",
55
"main": "./dist/cjs/index.js",
66
"module": "./dist/esm/index.js",
@@ -40,7 +40,6 @@
4040
},
4141
"dependencies": {
4242
"chalk": "^5.3.0",
43-
"cli-spinners": "^3.2.0",
4443
"inquirer": "^9.3.7",
4544
"is-admin": "^4.0.0",
4645
"ora": "^8.1.1",

src/index.ts

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ import chalk from "chalk";
1111
import sudo from "sudo-prompt";
1212
import isAdmin from "is-admin";
1313
import inquirer from "inquirer";
14-
import cliSpinners from "cli-spinners";
1514

1615
const options = { name: "RN Setup by Sumit Singh Rathore" };
1716

@@ -29,7 +28,6 @@ function checkCommand(command: string): boolean {
2928
async function installChocolatey() {
3029
const spinner = ora({
3130
text: chalk.blue("Installing Chocolatey..."),
32-
spinner: cliSpinners.dots,
3331
}).start();
3432

3533
try {
@@ -69,7 +67,6 @@ async function installChocolatey() {
6967
async function installJDK() {
7068
const spinner = ora({
7169
text: chalk.blue("Checking for JDK installation..."),
72-
spinner: cliSpinners.dots,
7370
}).start();
7471

7572
if (process.platform === "win32") {
@@ -121,7 +118,6 @@ async function installJDK() {
121118
async function installAndroidStudio() {
122119
const spinner = ora({
123120
text: chalk.blue("Checking for Android Studio installation..."),
124-
spinner: cliSpinners.dots,
125121
}).start();
126122

127123
const androidStudioPath = path.join(
@@ -215,7 +211,6 @@ async function promptUserForProjectDetails() {
215211
async function createReactNativeProject(projectName: string, template: string) {
216212
const spinner = ora({
217213
text: chalk.blue(`Creating React Native project "${projectName}"...`),
218-
spinner: cliSpinners.dots,
219214
}).start();
220215

221216
const templateOption =

0 commit comments

Comments
 (0)