You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-13Lines changed: 14 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,26 +72,26 @@
72
72
73
73
<!-- ABOUT THis PROJECT -->
74
74
## About This Project
75
-
This is a fresh & blank template, with some of the most common and helpful (but basic) modules included, as well as automatic [logging](#screenshots) configured out the box. After installation and starting the application, you will have a simple and empty HTTP REST Server hosted locally, ready-to-go. Everything inclusive of this template will be completely up to date, and updated each time it is installed, so it will never depreciate and is safe to use over time repeatedly. This is the perfect starting point for any project, as you can simply install this template and then start importing your own modules, or writing your own code, without any hastle. Completely compitible with any vision or modules.
75
+
This is a fresh & blank template, with some of the most common and helpful (but basic) modules included, as well as automatic [logging](#screenshots) configured out the box. After installation and starting the application, you will have a simple and empty HTTP REST Server hosted locally, ready-to-go. Everything inclusive of this template will be completely up to date, and updated each time it is installed, so it will never depreciate and is safe to use over time repeatedly. This is the perfect starting point for any project, as you can simply install this template and then start importing your own modules, or writing your own code, without any hassle. Completely compatible with any vision or modules.
76
76
77
-
**A new project can be written in either TypeScript or JavaScript, without any further changes needed, however this template is set up and intended for TS, making use of it's typesetting, precompiling abilities, and simplicity in a object-oriented approach.**
77
+
**A new project can be written in either TypeScript or JavaScript, without any further changes needed, however this template is set up and intended for TS, making use of it's typesetting, pre-compiling abilities, and simplicity in an object-oriented approach.**
78
78
79
-
*This template is completely unrestricted, and free for anyone to use, unlimitedly, with no credit or acknowledgements needed. There are no signs of any ownership, or personal touches, inside the codebase.*
79
+
*This template is completely unrestricted, and free for anyone to use, unlimited, with no credit or acknowledgements needed. There are no signs of any ownership, or personal touches, inside the codebase.*
80
80
81
81
<br>
82
82
83
83
### Tech Stack
84
84
*[Typescript](https://www.typescriptlang.org/) - Write in TypeScript (or JS), Compiles down to JavaScript.
*[@types/*](https://www.npmjs.com/package/@types/node) - Various JS->TS Typesetting modules, to import types. Needed to use a JavaScript module with TypeScrpt when strict settings are enabled, or to make use of TS only features against a imported module.
94
+
*[@types/*](https://www.npmjs.com/package/@types/node) - Various JS->TS Typesetting modules, to import types. Needed to use a JavaScript module with TypeScript when strict settings are enabled, or to make use of TS only features against a imported module.
95
95
96
96
<br>
97
97
@@ -153,21 +153,21 @@ Logging Sample<br>
153
153
154
154
155
155
## Complete Setup Instructions
156
-
The following steps are complete instruction to create this template, but without any of the extra modules, and begin a brand new project in Nodejs with Typscript from a blank slate. The commands are shell commands, to be carried out in a terminal, console or other shell environment.
156
+
The following steps are complete instruction to create this template, but without any of the extra modules, and begin a brand new project in Nodejs with TypeScript from a blank slate. The commands are shell commands, to be carried out in a terminal, console or other shell environment.
157
157
158
158
1. Create a new local directory and change current directory to new one:
159
159
```sh
160
160
mkdir <PROJECT_NAME>&&cd<PROJECT_NAME>
161
161
```
162
-
2.Initialise a new package.json file:
162
+
2.Initialize a new package.json file:
163
163
```sh
164
164
npm init -y
165
165
```
166
-
3. Install TypeScript dependancies:
166
+
3. Install TypeScript dependencies:
167
167
```sh
168
168
npm i --save-dev typescript ts-node
169
169
```
170
-
4.Initialise a new tsconfig.json file:
170
+
4.Initialize a new tsconfig.json file:
171
171
```sh
172
172
npx tsc --init
173
173
```
@@ -212,7 +212,7 @@ The following steps are complete instruction to create this template, but withou
212
212
npm run build
213
213
npm run start
214
214
```
215
-
<sub><b><i>^ Step 8.: These commands require the optional Step 7 to have been followed, to work as intended.<br>'npm run setup' installs and updates the project and it's dependancies, 'build' will compile the porject into browser/app runnable JS, and 'start' will run the project, from the compiled files in build. 'start:src' runs the project from the source TS file, so compilation is not neccessary.</i></b></sub>
215
+
<sub><b><i>^ Step 8.: These commands require the optional Step 7 to have been followed, to work as intended.<br>'npm run setup' installs and updates the project and it's dependencies, 'build' will compile the project into browser/app runnable JS, and 'start' will run the project, from the compiled files in build. 'start:src' runs the project from the source TS file, so compilation is not necessary.</i></b></sub>
216
216
217
217
<br><hr><br>
218
218
@@ -236,9 +236,10 @@ Below is the refined and confirmed roadmap, that has been planned for completion
236
236
237
237
| Version | Date | Changes |
238
238
|:---|:---|:---|
239
-
| 1.0.0 | 2021-07-09 | <ul><li>Initial Commit.</li><li>Add inital directory structure and files.</li><li>Add Screenshots directory, and images.</li><li>Create and format README.md</li></ul> |
239
+
| 1.0.0 | 2021-07-09 | <ul><li>Initial Commit.</li><li>Add initial directory structure and files.</li><li>Add Screenshots directory, and images.</li><li>Create and format README.md</li></ul> |
240
240
| 1.0.1 | 2021-07-14 | <ul><li>Removal of local SimpleTxtLogger file. Addition of SimpleTxtLogger as a npm module.</li><li>Update README.md</li></ul> |
0 commit comments