Skip to content

Commit 9966d1a

Browse files
author
Tom Berey
committed
Ver:1.0.0--Initial-Commit
1 parent 3ea3620 commit 9966d1a

3 files changed

Lines changed: 18 additions & 5 deletions

File tree

.github/workflows/codeql-analysis.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,11 @@ jobs:
7474
run: |
7575
npm install
7676
npm run build --if-present
77-
npm run cleanup --if-present
7877
7978
- name: update > install > build > test > clean
8079
run: |
8180
npm update
8281
npm install
8382
npm run build --if-present
8483
npm run lint --if-present
85-
npm run test:api --if-present
84+
npm run test:exit --if-present

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,12 @@
5454
<li><a href="#installation">Installation</a></li>
5555
</ul>
5656
</li>
57-
<li><a href="#usage">Usage</a></li>
57+
<li>
58+
<a href="#usage">Usage</a>
59+
<ul>
60+
<li><a href="#screenshots">Screenshots</a></li>
61+
</ul>
62+
</li>
5863
<li><a href="#complete-setup-instructions">Complete Setup Instructions</a></li>
5964
<li><a href="#changelog">Changelog</a></li>
6065
<li><a href="#contributing">Contributing</a></li>
@@ -67,7 +72,7 @@
6772

6873
<!-- ABOUT THis PROJECT -->
6974
## About This Project
70-
This is a fresh & blank template, with some of the most common and helpful (but basic) modules included. 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]() 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.
7176

7277
**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.**
7378

@@ -133,8 +138,17 @@ For help or guidance in downloading and running the application, see the followi
133138
|:---|:---|:---|
134139
| <ul><li>GET "/"</li></ul> | Homepage:<br>The client-side landing page. | <ul><li>"`http://localhost:3000/`"</li></ul> |
135140

141+
<br>
142+
143+
### Screenshots
144+
145+
Logging Sample<br>
146+
![Screenshot#5](https://github.com/tberey/social-stocks/blob/development/screenshots/local-logs-sample.png?raw=true)
147+
136148
<br><hr><br>
137149

150+
151+
138152
## Complete Setup Instructions
139153
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.
140154

src/Server.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export class Server extends ServerSetup {
1212

1313
private getRequests(): void {
1414
this.router.get('/', (req:Request, res:Response) => {
15-
this.txtLogger.writeToLogFile('Request Made: GET /test');
15+
this.txtLogger.writeToLogFile('Request Made: GET /');
1616

1717
const status = 200;
1818
res.status(status).render('index.ejs', { data: 'World' });

0 commit comments

Comments
 (0)