Skip to content

Commit e9d1e88

Browse files
authored
Update README.md
1 parent 9cb0204 commit e9d1e88

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
# React Component Templates, React Native Component Templates, Express Templates, Node Module Templates and Starters
1+
# React Component Templates, React Native Component Templates, Express Templates, Node Module Templates and Starters
22

3-
NPM package to easly create modules and components using your own templates(several pre-loaded as well) for any js project. Also give you the option to quickly edit the template according to your project.
3+
NPM package to easily create modules and components using your templates(several pre-loaded) for any js project. Also, give you the option to edit the template according to your project quickly.
44

5-
Imagine working on a project with more than 100s of react components. how good if we can create components using a npm task inside the project. This way, it will save time and helps to maintain consistency throughout the files. And of course, you can approach this in various ways. Such as
5+
Imagine working on a project with more than 100s of react components. How good if we can create components using an npm task inside the project. This way, it will save time and helps to maintain consistency throughout the project. And of course, you can approach this in various ways. Such as
66

77
- Create and template file type on the code editor.
88
- Use a plugin that gives snippets for the code editor.
99

10-
The way I see it is when you work with multiple different teams on different projects, it is always useful to have isolated project standerds that can be easily adjustable for the whole team.
10+
The way I see it is when you work with multiple different teams on different projects, it is always useful to have isolated project standards that can be easily adjustable for the whole team.
1111

1212
Example:
1313

14-
lets say on a react project whenever we create an functional componant we do follwing steps.
14+
let's say on a react project whenever we create a functional component we do following steps.
1515

1616
1. create a folder with component name - Login
17-
2. create 3 files inside this folder - Login.tsx, Login.module.css, Login.test.ts
18-
3. create basic code structures on each of those files with relevent class names and module names.
17+
2. create three files inside this folder - Login.tsx, Login.module.css, Login.test.ts
18+
3. create basic code structures on each of those files with relevant class names and module names.
1919

20-
what this tool does is automate this whole process. you and your team team can create a template you like and this tool will create files with the name you input and replace the content in your template files whenever you create a new module.
20+
What this tool does is automate this whole process. You and your team can create a template you like, and this tool will create files with the name you input and replace the content in your template files whenever you create a new module.
2121

2222
![demo](https://github.com/razorRun/react-react-native-component-node-module-templates/blob/main/demo.gif?raw=true)
2323

@@ -29,16 +29,16 @@ what this tool does is automate this whole process. you and your team team can c
2929

3030
`node node_modules/react-react-native-component-node-module-templates/init.js`
3131

32-
You will notice this will crate an entry called `gen` in your package.json and copy a folder to your project root called
33-
`developer-templates`. Fell free to edit the as you see needed.
32+
You will notice this will create an entry called `gen` in your package.json and copy a folder to your project root called
33+
`developer-templates`. Fell free to edit them as you see needed.
3434

3535
#### To run the generator
3636

3737
`npm run gen`
3838

3939
See [NPM script to automate tasks in React and other JS Projects](https://roshan.digital/npm-script-to-save-time-react-project/) post for more information.
4040

41-
To Add a new Template
41+
To add a new Template
4242
1. Create a folder inside `developer-templates` folder with the repo type ex:react
4343
2. Create child folder with the template files type ex: component,module
4444
3. Create user-input-map.json file indicating what are the values user should input and how they should get replaced.

0 commit comments

Comments
 (0)