Skip to content

Commit c4cdafc

Browse files
Initialize project with TypeScript configuration, npm ignore, and essential files
0 parents  commit c4cdafc

File tree

10 files changed

+2443
-0
lines changed

10 files changed

+2443
-0
lines changed

.gitignore

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Node.js
2+
node_modules/
3+
npm-debug.log*
4+
yarn-debug.log*
5+
yarn-error.log*
6+
7+
# TypeScript
8+
*.tsbuildinfo
9+
10+
# Logs
11+
logs/
12+
*.log
13+
logs/*.log
14+
15+
# Dependency directories
16+
jspm_packages/
17+
18+
# Optional npm cache directory
19+
.npm
20+
21+
# Optional eslint cache
22+
.eslintcache
23+
24+
# Optional REPL history
25+
.node_repl_history
26+
27+
# Output of 'npm pack'
28+
*.tgz
29+
30+
# dotenv environment variables file
31+
.env
32+
33+
# VS Code
34+
.vscode/
35+
36+
# MacOS
37+
.DS_Store
38+
39+
# Windows
40+
Thumbs.db
41+
ehthumbs.db
42+
43+
# IDEs and editors
44+
.idea/
45+
.project
46+
.classpath
47+
.c9/
48+
*.launch
49+
.settings/
50+
*.sublime-workspace
51+
52+
# Build directories
53+
dist/
54+
build/
55+
56+
# Coverage directory used by tools like istanbul
57+
coverage/
58+
59+
# Temporary files
60+
tmp/
61+
temp/
62+
63+
# TypeScript cache
64+
*.tsbuildinfo
65+
66+
# Ignore bin directory
67+
# bin/

.npmignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
node_modules/
2+
src/
3+
*.ts
4+
dist/
5+
.git/

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Sumit Singh Rathore
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# React Native CLI Setup
2+
3+
![License](https://img.shields.io/badge/license-MIT-blue.svg)
4+
![Version](https://img.shields.io/badge/version-1.0.0-red.svg)
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

Comments
 (0)