Skip to content

Commit c67b98e

Browse files
committed
🎉 First commit
0 parents  commit c67b98e

34 files changed

+19361
-0
lines changed

.env.example

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
DB_HOST=localhost
2+
DB_NAME=name
3+
DB_PASSWORD=password
4+
DB_PORT=3306
5+
DB_TYPE=mysql
6+
DB_USER=username
7+
PORT=5000
8+
9+
10+
11+
TOKEN_EXPIRY_HOUR=168
12+
SECRET=askjfghhwifuhgw
13+
14+
EMAIL_SERVICE=gmail
15+
EMAIL_USER=you@email.com
16+
EMAIL_PASS=fzobeitqjcxklenm
17+
EMAIL_FROM=admin@email.com
18+
19+
OTP_EXPIRY_MIN=10
20+
OTP_SECRET=shgdbnbgw
21+

.eslintignore

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# /node_modules/* in the project root is ignored by default
2+
# build artefacts
3+
dist/*
4+
coverage/*
5+
# data definition files
6+
**/*.d.ts
7+
# 3rd party libs
8+
/src/public/
9+
# custom definition files
10+
/src/types/

.eslintrc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"parser": "@typescript-eslint/parser",
3+
"extends": ["plugin:@typescript-eslint/recommended","prettier"],
4+
"parserOptions": {
5+
"ecmaVersion": 2018,
6+
"sourceType": "module"
7+
},
8+
"rules": {
9+
"semi": ["error", "always"],
10+
"quotes": ["error", "double"],
11+
"@typescript-eslint/explicit-function-return-type": "off",
12+
"@typescript-eslint/no-explicit-any": 1,
13+
"@typescript-eslint/no-inferrable-types": [
14+
"warn", {
15+
"ignoreParameters": true
16+
}
17+
],
18+
"@typescript-eslint/no-unused-vars": "warn"
19+
}
20+
}

.gitignore

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
lib-cov
2+
*.seed
3+
*.log
4+
*.csv
5+
*.dat
6+
*.out
7+
*.pid
8+
*.gz
9+
*.swp
10+
11+
pids
12+
logs
13+
results
14+
tmp
15+
16+
# Build
17+
public/css/main.css
18+
19+
# Coverage reports
20+
coverage
21+
22+
# API keys and secrets
23+
.env
24+
25+
# Dependency directory
26+
node_modules
27+
bower_components
28+
29+
# Editors
30+
.idea
31+
*.iml
32+
33+
# OS metadata
34+
.DS_Store
35+
Thumbs.db
36+
37+
# Ignore built ts files
38+
dist/**/*
39+
40+
# ignore yarn.lock
41+
yarn.lock

.prettierrc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"semi": true,
3+
"singleQuote": false,
4+
"arrowParens": "avoid"
5+
}

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Typescript-Node-Sequelize-Boilerplate
2+
3+
- Node (TypeScript)
4+
- MySql
5+
6+
## Getting started
7+
8+
```
9+
npm install
10+
11+
npm run build-ts
12+
13+
npm start
14+
15+
```
16+
17+
## For development
18+
19+
```
20+
npm install
21+
22+
npm run watch
23+
24+
```
25+
26+
## Sample .ENV
27+
```
28+
DB_HOST=localhost
29+
DB_NAME=name
30+
DB_PASSWORD=password
31+
DB_PORT=3306
32+
DB_TYPE=mysql
33+
DB_USER=username
34+
PORT=5000
35+
36+
37+
38+
TOKEN_EXPIRY_HOUR=168
39+
SECRET=askjfghhwifuhgw
40+
41+
EMAIL_SERVICE=gmail
42+
EMAIL_USER=you@email.com
43+
EMAIL_PASS=fzobeitqjcxklenm
44+
EMAIL_FROM=admin@email.com
45+
46+
OTP_EXPIRY_MIN=10
47+
OTP_SECRET=shgdbnbgw
48+
49+
```
50+
51+
52+

0 commit comments

Comments
 (0)