Skip to content

Commit ff7d087

Browse files
authored
Fix grammar and clarity in dev_guide (#449) (#451)
* Update dev_guide.md
1 parent 2025137 commit ff7d087

File tree

1 file changed

+50
-51
lines changed

1 file changed

+50
-51
lines changed

docs/dev_guide.md

Lines changed: 50 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,30 @@
22

33
## Getting the code
44

5-
1. Fork this repository,
5+
1. Fork this repository
66

7-
2. Clone your forked copy of the project;
7+
2. Clone your forked copy of the project
88

9-
```bash
10-
git clone https://github.com/<your_user_name>/www-v2.git
11-
```
9+
```bash
10+
git clone https://github.com/<your_user_name>/www-v2.git
11+
```
1212

13-
3. Change to the project directory;
13+
3. Change to the project directory
1414

15-
```bash
16-
cd www-v2
17-
```
15+
```bash
16+
cd www-v2
17+
```
1818

1919
## Setup Development Environment
2020

21-
This is a _**TypeScript**_ project that uses _**React**_. You'll just need _[**Node.js**](https://nodejs.org/en) and _**npm**_ installed on your development machine.
22-
Although, this is sufficient to run, build, and test the project as a whole, you might need some
23-
extra tools for other development tasks.
21+
This is a _**TypeScript**_ project that uses _**React**_. You'll just need
22+
_[**Node.js**](https://nodejs.org/en)_ and _**npm**_ installed on your development machine.
23+
This is sufficient to run, build, and test the project as a whole, but you might need extra tools for other development tasks.
2424

25-
You'll need _**tsc**_ (_TypeScript Compiler_) to manually compile `.ts` files. You'll need
26-
_**ts-node**_ (_Node.js executable for TypeScript_) to manually execute `.ts` scripts directly. Finally,
25+
You'll need _**tsc**_ (_TypeScript Compiler_) to manually compile `.ts` files, and
26+
_**ts-node**_ (_Node.js executable for TypeScript_) to manually execute .ts scripts directly.
2727

28-
Once _**npm**_ is installed, to install the above, run
28+
Finally, once _**npm**_ is installed, to install the above, run
2929

3030
```bash
3131
npm i -g typescript
@@ -40,7 +40,7 @@ Check installation using
4040
node -v && npm -v && tsc -v && ts-node -v
4141
```
4242

43-
Output should look like
43+
Expected output:
4444

4545
```bash
4646
v23.7.0
@@ -51,67 +51,66 @@ v10.9.2
5151

5252
## Commands
5353

54-
After you are set-up, the steps you take depend on what you want to do:
54+
After setup, the steps you take depend on what you want to do:
5555

5656
- **Run a development server**
57+
1. To install all the dependencies (in `package.json`), run
5758

58-
1. To install all the dependencies (in `package.json`), run
59+
```bash
60+
npm install
61+
```
5962

60-
```bash
61-
npm install
62-
```
63+
2. Run _React scripts_.
64+
- For unoptimized development serving, run
6365

64-
2. Run _React scripts_.
66+
```bash
67+
npm run dev
68+
```
6569

66-
- For unoptimized development serving, run
70+
Visit `localhost:5173` in a browser to view the web page served.
6771

68-
```bash
69-
npm run dev
70-
```
72+
- For generating a generic production build, run
7173

72-
Visit `localhost:5173` in a browser to view the web page served.
74+
```bash
75+
npm run build
76+
```
7377

74-
- For generating a generic production build, run
78+
- For generating a production build under the subdirectory `/www-v2`, run
7579

76-
```bash
77-
npm run build
78-
```
80+
```bash
81+
npm run build
82+
```
7983

80-
- For generating a production build under the subdirectory `/www-v2`, run
84+
- For serving the last production build (`dist` folder), run
8185

82-
```bash
83-
npm run build
84-
```
86+
```bash
87+
npm run preview
88+
```
8589

86-
- For serving the last production build (`dist` folder), run
87-
88-
```bash
89-
npm run preview
90-
```
91-
92-
Visit `localhost:4173` in a browser to view the web page served.
90+
Visit `localhost:4173` in a browser to view the web page served.
9391

9492
## Editor
9593

96-
_All code is just plain text, so it doesn't really matter what you use to edit them._ However,
97-
using modern, feature-rich IDEs/text-editors like:
94+
_All code is just plain text, so any editor works._ However, using modern,
95+
feature-rich IDEs/text-editors like:
9896
[_**Atom**_](https://github.blog/2022-06-08-sunsetting-atom/),
9997
[_**Brackets**_](https://brackets.io),
10098
[_**WebStorm**_](https://www.jetbrains.com/webstorm/),
10199
[_**Sublime Text**_](https://www.sublimetext.com/),
102-
[_**Visual Studio Code**_](https://code.visualstudio.com/), etc. makes life way easier. These come
103-
with a directory-tree explorer, and an integrated terminal, at the very least, while having support
104-
for plugins/extensions to expand their functionality.
100+
[_**Visual Studio Code**_](https://code.visualstudio.com/), etc. makes development way easier.They provide a directory-tree explorer,
101+
integrated terminal, and support for plugins/extensions to expand their functionality.
105102

106103
Some (non-exhaustive) benefits of using these are _syntax highlighting_,
107104
_warning/error annotations_, _formatting_, _auto-refactoring_, tons of customizable
108105
_keyboard shortcuts_, etc.
109106

110-
_**Visual Studio Code**_ (_**VSCode**_) is currently the most-popular code editor for reasons like
111-
being _lightweight_, _cleaner_, large marketplace of _extensions_, integrated _source control_
112-
features, _debugger_, _remote explorer_ support, _regular expression_ based find/replace, etc.
107+
_**Visual Studio Code**_ (_**VSCode**_) is currently the most popular code editor due
108+
to being _lightweight_, _clean_, having a large _extensions_ marketplace, integrated
109+
_source control_ features, a _debugger_, _remote explorer_ support, and
110+
_regular-expression-based find/replace_.
113111

114-
Recommended extensions for this project are `Babel JavaScript`, `ESLint`, `Git Graph`,`GitLens`, `markdownlint`, `Prettier`, `Tailwind CSS IntelliSense`, and `SVG`.
112+
Recommended extensions for this project are `Babel JavaScript`, `ESLint`, `Git Graph`,
113+
`GitLens`, `markdownlint`, `Prettier`, `Tailwind CSS IntelliSense`, and `SVG`.
115114

116115
All that, however, shouldn't necessarily stop you from using _**Emacs**_, _**Nano**_, or _**Vim**_,
117116
if that's your poison :D. Happy coding!

0 commit comments

Comments
 (0)