Skip to content

Commit 0c79c76

Browse files
committed
added helmet, vscode settings, updated packages
1 parent 50be033 commit 0c79c76

19 files changed

+405
-1091
lines changed

.editorconfig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ charset = utf-8
99
indent_style = space
1010
indent_size = 2
1111
insert_final_newline = true
12-
trim_trailing_whitespace = true
12+
trim_trailing_whitespace = true

.gitignore

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,4 @@ typings/
7070
.env
7171

7272

73-
### VisualStudioCode ###
74-
.vscode/*
75-
!.vscode/settings.json
76-
!.vscode/tasks.json
77-
!.vscode/launch.json
78-
!.vscode/extensions.json
79-
80-
# End of https://www.gitignore.io/api/node,visualstudiocode
73+
# End of https://www.gitignore.io/api/node,visualstudiocode

.vscode/extensions.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"recommendations": [
3+
"christian-kohler.npm-intellisense",
4+
"christian-kohler.path-intellisense",
5+
"eg2.tslint",
6+
"esbenp.prettier-vscode",
7+
"wix.vscode-import-cost"
8+
]
9+
}

.vscode/settings.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"editor.formatOnSave": true,
3+
"editor.formatOnPaste": true,
4+
"prettier.singleQuote": true,
5+
"prettier.trailingComma": "all",
6+
"prettier.tslintIntegration": true,
7+
"editor.fontFamily": "Fira Code, Consolas, 'Courier New', monospace"
8+
}

Readme.MD

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,46 @@
1-
21
# REST API with Node using Typescript
32

43
This is a simple REST API developed using node and express with typescript
54

6-
![alt text](https://image.ibb.co/nAd9OF/logos.png "Node Typescript")
7-
5+
![alt text](https://image.ibb.co/nAd9OF/logos.png 'Node Typescript')
86

97
## Requirements
10-
[Node.js](https://nodejs.org/en/), [postgresql](https://www.postgresql.org/download/)
8+
9+
[Node.js](https://nodejs.org/en/), [postgresql](https://www.postgresql.org/download/)
1110

1211
## Setup DB
13-
1) you need to install PostgreSQL and then set the following environment variable
14-
`C:\Program Files\PostgreSQL\10\bin`,
15-
`C:\Program Files\PostgreSQL\10\lib`
16-
2) rename `.env-sample` to `.env` in the file the DB connection string need to be updated accoring to your `credentials`.
17-
ex : `postgres://<YourUserName>:<YourPassword>@localhost:5432/<YourDatabase>`
1812

19-
3) you can find the DB and other details under `src/db`
20-
create database with the name `complete-typescript-course` and then run/ import the `.sql` files
13+
1. you need to install PostgreSQL and then set the following environment variable
14+
`C:\Program Files\PostgreSQL\10\bin`,
15+
`C:\Program Files\PostgreSQL\10\lib`
16+
2. rename `.env-sample` to `.env` in the file the DB connection string need to be updated accoring to your `credentials`.
17+
ex : `postgres://<YourUserName>:<YourPassword>@localhost:5432/<YourDatabase>`
18+
19+
3. you can find the DB and other details under `src/db`
20+
create database with the name `complete-typescript-course` and then run/ import the `.sql` files
2121

2222
## Setup
2323

2424
clone the repo then goto that directory and run following commands
2525

26-
`npm install`
26+
`npm install`
2727

28-
To transpile .ts files to .js run
28+
To transpile .ts files to .js run
2929

30-
`npm run watch`
30+
`npm run watch`
3131

3232
To start the Application
3333

34-
`nodemon or npm start`
34+
`nodemon or npm start`
3535

3636
this will run on port 3000 you can change on config or
3737

3838
`node server.js -p <PORT>`
3939

40+
## Recommended / Preferred
4041

42+
[VSCode](https://code.visualstudio.com/download)
4143

4244
## Credits to
43-
Angular University [complete-typescript-course](https://github.com/angular-university/complete-typescript-course)
44-
45-
46-
47-
4845

46+
Angular University [complete-typescript-course](https://github.com/angular-university/complete-typescript-course)

0 commit comments

Comments
 (0)