Skip to content

Commit 336693b

Browse files
author
Tom Berey
committed
Ver:1.0.3--Minor-Updates
1 parent e2530a0 commit 336693b

1 file changed

Lines changed: 14 additions & 13 deletions

File tree

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -72,26 +72,26 @@
7272

7373
<!-- ABOUT THis PROJECT -->
7474
## 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.
7676

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.**
7878

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.*
8080

8181
<br>
8282

8383
### Tech Stack
8484
* [Typescript](https://www.typescriptlang.org/) - Write in TypeScript (or JS), Compiles down to JavaScript.
8585
* [NodeJS](https://nodejs.org/en/) - Node Runtime Environment.
86-
* [ExpressJS](https://expressjs.com/) - Server & Router Infrastrusture Framework.
86+
* [ExpressJS](https://expressjs.com/) - Server & Router Infrastructure Framework.
8787
* [EJS](https://ejs.co/) - Serves Client Views.
8888
* [ESLint](https://eslint.org/) - Code Parsing, Styling & Error Checking.
8989
* [Mocha-Chai](https://mochajs.org/) - Testing with Mocha Framework, using the Chai Library.
9090
* [Nodemon](https://nodemon.io/) - Restart Application without Compiling, on a Change to Watched Files.
9191
* [Rimraf](https://www.npmjs.com/package/rimraf) - Directory Cleaner Tool.
9292
* [Dotenv](https://www.npmjs.com/package/dotenv) - Project Secrets Stored in a Local .env File.
9393
* [SimpleTxtLogger](https://www.npmjs.com/package/simple-txt-logger) - Logging tool.
94-
* [@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.
9595

9696
<br>
9797

@@ -153,21 +153,21 @@ Logging Sample<br>
153153

154154

155155
## 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.
157157

158158
1. Create a new local directory and change current directory to new one:
159159
```sh
160160
mkdir <PROJECT_NAME> && cd <PROJECT_NAME>
161161
```
162-
2. Initialise a new package.json file:
162+
2. Initialize a new package.json file:
163163
```sh
164164
npm init -y
165165
```
166-
3. Install TypeScript dependancies:
166+
3. Install TypeScript dependencies:
167167
```sh
168168
npm i --save-dev typescript ts-node
169169
```
170-
4. Initialise a new tsconfig.json file:
170+
4. Initialize a new tsconfig.json file:
171171
```sh
172172
npx tsc --init
173173
```
@@ -212,7 +212,7 @@ The following steps are complete instruction to create this template, but withou
212212
npm run build
213213
npm run start
214214
```
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>
216216

217217
<br><hr><br>
218218

@@ -236,9 +236,10 @@ Below is the refined and confirmed roadmap, that has been planned for completion
236236

237237
| Version | Date | Changes |
238238
|:---|:---|:---|
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> |
240240
| 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> |
241241
| 1.0.2 | 2021-08-01 | <ul><li>Update tsconfig.</li><li>Update README.md</li></ul> |
242+
| 1.0.3 | 2021-08-03 | <ul><li>Fix Spelling.</li><li>Update README.md</li></ul> |
242243

243244
<br><hr><br>
244245

@@ -266,7 +267,7 @@ Contributions are welcomed and, of course, **greatly appreciated**.
266267
* [Issues & Requests.][issues-url]
267268
* [My Other Projects.](https://github.com/tberey?tab=repositories)
268269
* [Personal Website.](https://tberey.github.io/)
269-
* [Linked In.](https://uk.linkedin.com/in/thomas-berey-2a1860129)
270+
* [Linked In.](https://uk.linkedin.com/in/thomas-berey)
270271

271272
<br>
272273

@@ -294,5 +295,5 @@ Contributions are welcomed and, of course, **greatly appreciated**.
294295
[issues-shield]: https://img.shields.io/github/issues/tberey/typescript-node-fresh-start-template.svg
295296
[issues-url]: https://github.com/tberey/typescript-node-fresh-start-template/issues
296297
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?logo=linkedin&colorB=555
297-
[linkedin-url]: https://uk.linkedin.com/in/thomas-berey-2a1860129
298+
[linkedin-url]: https://uk.linkedin.com/in/thomas-berey
298299
[project-url]: https://github.com/tberey/typescript-node-fresh-start-template/projects

0 commit comments

Comments
 (0)