Skip to content

Commit 9a5bf3d

Browse files
MannyManny
Manny
authored and
Manny
committed
feat: initial-commit
First commit that has the full functionlity of a rest auth application. BREAKING CHANGE: Initial Commit
0 parents  commit 9a5bf3d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+2657
-0
lines changed

‎.env.example

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
PORT=5000
2+
NODE_ENV=development
3+
VERSION=1.0.0
4+
5+
JWT_SECRET=jwt_secret_key
6+
JWT_ISSUER=api.localhost
7+
JWT_AUDIENCE=api.localhost
8+
JWT_MAX_AGE=900
9+
10+
JWT_REFESH_SECRET=jwt_refresh_secret_key
11+
JWT_REFRESH_MAX_AGE=604800
12+
13+
JWT_RESET_SECRET=jwt_reset_secret_key
14+
JWT_RESET_MAX_AGE=300
15+
16+
CSRF_COOKIE_PREFIX=nodetscookie
17+
CSRF_COOKIE_MAXAGE=900
18+
19+
MAILGUN_API_URL=
20+
MAILGUN_SECRET_KEY=
21+
MAILGUN_DOMAIN=
22+
23+
EMAIL_FROM=noreply
24+
EMAIL_SUBJECT_RESET="Reset Your Password"
25+
EMAIL_SUBJECT_CONFIRM="Confirm Account"
26+
EMAIL_URL_RESET_PASSWORD=http://localhost:3000/auth/reset
27+
EMAIL_URL_CONFIRM_ACCOUNT=http://localhost:3000/auth/confirm

‎.eslintignore

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
node_modules
2+
build
3+
dist
4+
*.log
5+
coverage
6+
prisma/migrations/*.lock

‎.eslintrc.js

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
module.exports = {
2+
parser: '@typescript-eslint/parser',
3+
extends: [
4+
'prettier/@typescript-eslint',
5+
'plugin:jest/recommended',
6+
'plugin:@typescript-eslint/recommended',
7+
'plugin:prettier/recommended',
8+
],
9+
rules: {
10+
'@typescript-eslint/explicit-function-return-type': 'off',
11+
},
12+
parserOptions: {
13+
ecmaVersion: 2020,
14+
sourceType: 'module',
15+
},
16+
env: {
17+
jest: true,
18+
},
19+
};

‎.gitignore

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
node_modules/
2+
build
3+
dist
4+
*.log
5+
.env
6+
yarn.lock
7+
package-lock.json
8+
.eslintcache
9+
**/.DS_Store
10+
coverage
11+
prisma/migrations/*.lock

‎.huskyrc

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"hooks": {
3+
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
4+
"pre-commit": "./node_modules/.bin/lint-staged"
5+
}
6+
}

‎.lintstagedrc

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"*.{ts,js,json,md}": [
3+
"prettier --write"
4+
]
5+
}

‎.nvmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
12.18.1

‎.prettierignore

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
node_modules
2+
build
3+
dist
4+
*.log
5+
coverage
6+
prisma/migrations/*.lock

‎.prettierrc

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"printWidth": 80,
3+
"tabWidth": 2,
4+
"useTabs": false,
5+
"semi": true,
6+
"singleQuote": true,
7+
"trailingComma": "all",
8+
"proseWrap": "always"
9+
}

‎.vscode/settings.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"editor.formatOnSave": true,
3+
"editor.formatOnType": true,
4+
"editor.formatOnPaste": true
5+
}

‎README.md

+165
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
# NodeTS REST Auth Bootstrap
2+
3+
Original based off the
4+
[NodeTS Bootstrap](https://github.com/codingwithmanny/nodets-bootstrap)
5+
repository.
6+
7+
This is a base NodeJS REST Auth TypeScript App built with express and all
8+
configurations files included.
9+
10+
This repository is meant to be a base to build on top of for building an API.
11+
12+
## Copy This App
13+
14+
```bash
15+
git clone https://github.com/codingwithmanny/nodets-rest-auth-bootstrap myproject;
16+
cd myproject;
17+
rm -rf .git;
18+
git init -y;
19+
git remote add origin https://github.com/your/newrepo;
20+
```
21+
22+
## Requirements
23+
24+
- NodeJS 12.18.1 or NVM
25+
- Docker or Postgres Database
26+
- MailGun account for emails
27+
28+
## Local Setup
29+
30+
While in project directory:
31+
32+
**0 - (Optional) NVM Installation**
33+
34+
```bash
35+
nvm install;
36+
```
37+
38+
**1 - Install Depencies**
39+
40+
```bash
41+
yarn install; # npm install;
42+
```
43+
44+
**2 - Start Database**
45+
46+
Using `Docker`
47+
48+
```bash
49+
docker run -it -d -p 5432:5432 -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=secret -e POSTGRES_DB=postgres --name nodetsdb postgres;
50+
```
51+
52+
**3 - Configure Database Environment Variables**
53+
54+
**File:** `./prisma/.env`
55+
56+
```bash
57+
DATABASE_URL="postgresql://postgres:secret@localhost:5432/postgres?schema=public"
58+
```
59+
60+
**4 - Run Migrations**
61+
62+
```bash
63+
yarn db:migrate; # npm run db:migrate;
64+
```
65+
66+
**5 - Setup ENV VARS**
67+
68+
**NOTE:** Make sure to fill them with the correct ENV Variables
69+
70+
```bash
71+
cp .env.example .env;
72+
```
73+
74+
**6 - Server Start**
75+
76+
`Development:`
77+
78+
```bash
79+
yarn dev; # npm dev;
80+
```
81+
82+
`Production:`
83+
84+
```bash
85+
yarn start; # npm start;
86+
```
87+
88+
**7 - (Optional) Seeding**
89+
90+
```bash
91+
yarn db:seed:all; # npm run db:seed:all
92+
```
93+
94+
## Production Commands
95+
96+
`Build`
97+
98+
```bash
99+
yarn build; # npm run build
100+
```
101+
102+
`Build & Serve`
103+
104+
```bash
105+
yarn start; # npm start
106+
```
107+
108+
## Tests
109+
110+
`All Tests`
111+
112+
```bash
113+
yarn test; # npm run test;
114+
```
115+
116+
`Jest Watch`
117+
118+
```bash
119+
yarn test:jest; # npm run test:jest;
120+
```
121+
122+
`Jest Coverage`
123+
124+
```bash
125+
yarn test:coverage; # npm run test:coverage;
126+
```
127+
128+
`Eslint`
129+
130+
```bash
131+
yarn test:lint; # npm run test:lint
132+
```
133+
134+
## Development
135+
136+
Guidelines for development
137+
138+
### New Migration
139+
140+
There is a checklist for creating a new migration:
141+
142+
- [ ] - Create new model in `./prisma/schema.prisma`
143+
- [ ] - Double check that it adheres to the criteria
144+
- [ ] - `yarn db:save;`
145+
- [ ] - `yarn db:gen;`
146+
- [ ] - Create new sed `yarn db:seed:gen` and modify `NEW.ts` with name
147+
`ModelNameSeed.ts`
148+
- [ ] - Run migrations `yarn db:migrate`
149+
- [ ] - Write tests
150+
151+
Create new models in the `./prisma/schema.prisma` file.
152+
153+
**Criteria:**
154+
155+
- Singular: `User` _NOT_ `Users`
156+
- Camelcase capitalized `MyModel` _NOT_ `myModel`
157+
158+
**Example:**
159+
160+
```prima
161+
model ModelName {
162+
id String @default(uuid()) @id
163+
updated_at DateTime @default(now())
164+
}
165+
```

‎commitlint.config.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = { extends: ['@commitlint/config-conventional'] };

‎jest.config.js

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
module.exports = {
2+
preset: 'ts-jest',
3+
testEnvironment: 'node',
4+
};

‎package.json

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
{
2+
"name": "nodets-bootstrap",
3+
"version": "1.0.0",
4+
"main": "src/index.js",
5+
"repository": "https://github.com/codingwithmanny/nodets-base",
6+
"author": "@codingwithmanny",
7+
"license": "MIT",
8+
"scripts": {
9+
"commit": "git-cz",
10+
"build": "tsc",
11+
"dev": "ts-node-dev src/server.ts",
12+
"start": "export NODE_ENV=production && tsc && node build/server.js",
13+
"test": "yarn test:lint && yarn test:coverage",
14+
"test:jest": "./node_modules/.bin/jest --watch",
15+
"test:coverage": "./node_modules/.bin/jest --coverage",
16+
"test:lint": "./node_modules/.bin/eslint '*/**/*.{js,ts}' --quiet --fix",
17+
"db:save": "./node_modules/.bin/prisma migrate save --experimental",
18+
"db:seed:gen": "cp ./prisma/seedings/TemplateSeeder.ts.example ./prisma/seedings/NEW.ts",
19+
"db:seed:all": "./node_modules/.bin/ts-node-dev ./prisma/seedings/index.ts",
20+
"db:gen": "./node_modules/.bin/prisma generate",
21+
"db:migrate": "./node_modules/.bin/prisma migrate up --experimental",
22+
"db:rollback": "./node_modules/.bin/prisma migrate down --experimental"
23+
},
24+
"dependencies": {
25+
"@prisma/client": "^2.1.3",
26+
"axios": "^0.19.2",
27+
"bcrypt": "^5.0.0",
28+
"cookie-parser": "^1.4.5",
29+
"cors": "^2.8.5",
30+
"csurf": "^1.11.0",
31+
"dotenv": "^8.2.0",
32+
"express": "^4.17.1",
33+
"express-validator": "^6.6.0",
34+
"form-data": "^3.0.0",
35+
"helmet": "^3.23.3",
36+
"http-errors": "^1.8.0",
37+
"jsonwebtoken": "^8.5.1",
38+
"jwt-decode": "^2.2.0",
39+
"rand-token": "^1.0.1",
40+
"typescript": "^3.9.6"
41+
},
42+
"config": {
43+
"commitizen": {
44+
"path": "cz-conventional-changelog"
45+
}
46+
},
47+
"devDependencies": {
48+
"@commitlint/cli": "^9.0.1",
49+
"@commitlint/config-conventional": "^9.0.1",
50+
"@prisma/cli": "^2.1.3",
51+
"@types/axios": "^0.14.0",
52+
"@types/bcrypt": "^3.0.0",
53+
"@types/cookie-parser": "^1.4.2",
54+
"@types/cors": "^2.8.6",
55+
"@types/csurf": "^1.9.36",
56+
"@types/express": "^4.17.6",
57+
"@types/faker": "^4.1.12",
58+
"@types/helmet": "^0.0.47",
59+
"@types/http-errors": "^1.6.3",
60+
"@types/jest": "^26.0.3",
61+
"@types/jsonwebtoken": "^8.5.0",
62+
"@types/jwt-decode": "^2.2.1",
63+
"@types/node": "^14.0.14",
64+
"@typescript-eslint/eslint-plugin": "^3.5.0",
65+
"@typescript-eslint/parser": "^3.5.0",
66+
"eslint": "^7.3.1",
67+
"eslint-config-prettier": "^6.11.0",
68+
"eslint-plugin-jest": "^23.17.1",
69+
"eslint-plugin-prettier": "^3.1.4",
70+
"faker": "^4.1.0",
71+
"husky": "^4.2.5",
72+
"jest": "^26.1.0",
73+
"lint-staged": "^10.2.11",
74+
"prettier": "^2.0.5",
75+
"ts-jest": "^26.1.1",
76+
"ts-node-dev": "^1.0.0-pre.50"
77+
}
78+
}

‎prisma/.env.example

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Environment variables declared in this file are automatically made available to Prisma.
2+
# See the documentation for more detail: https://pris.ly/d/prisma-schema#using-environment-variables
3+
4+
# Prisma supports the native connection string format for PostgreSQL, MySQL and SQLite.
5+
# See the documentation for all the connection string options: https://pris.ly/d/connection-strings
6+
7+
DATABASE_URL="postgresql://johndoe:randompassword@localhost:5432/mydb?schema=public"

‎prisma/migrations/20200704130613-init-database/README.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Migration `20200704130613-init-database`
2+
3+
This migration has been generated by Manny at 7/4/2020, 1:06:13 PM. You can
4+
check out the [state of the schema](./schema.prisma) after the migration.
5+
6+
## Database Steps
7+
8+
```sql
9+
10+
```
11+
12+
## Changes
13+
14+
```diff
15+
diff --git schema.prisma schema.prisma
16+
migration ..20200704130613-init-database
17+
--- datamodel.dml
18+
+++ datamodel.dml
19+
@@ -1,0 +1,11 @@
20+
+// This is your Prisma schema file,
21+
+// learn more about it in the docs: https://pris.ly/d/prisma-schema
22+
+
23+
+datasource db {
24+
+ provider = "postgresql"
25+
+ url = "***"
26+
+}
27+
+
28+
+generator client {
29+
+ provider = "prisma-client-js"
30+
+}
31+
```

0 commit comments

Comments
 (0)