feat: initial typescript setup completed

.eslintignore

@@ -1,2 +1,3 @@
 node_modules
-.env
+.env
+./dist

.eslintrc.cjs

@@ -4,30 +4,40 @@ module.exports = {
         node: true,
         jest: true,
     },
+    parser: '@typescript-eslint/parser',
     parserOptions: {
-        ecmaVersion: 2020,
+        project: ['./tsconfig.json'],
+        ecmaVersion: 2021,
     },
     extends: [
+        'eslint:recommended',
         'airbnb-base',
+        'airbnb-typescript/base',
+        'plugin:@typescript-eslint/recommended'
     ],
     plugins: [
         'import',
     ],
     rules: {
         'import/extensions': [
-            'error',
+            'warn',
             {
+                ts: true,
                 js: true,
-                svg: true,
+                json: true
             },
         ],
         'no-underscore-dangle': 'off',
+        'array-callback-return': 'off',
         'newline-before-return': 'error',
-        'consistent-return': 'error',
+        'consistent-return': 'off',
+        '@typescript-eslint/naming-convention': 'off',
         'no-else-return': ['error', { allowElseIf: false }],
         'class-methods-use-this': 'off',
         indent: ['error', 4, { SwitchCase: 1 }],
+        '@typescript-eslint/indent': ['error', 4, { SwitchCase: 1 }],
         semi: ['error', 'never'],
+        '@typescript-eslint/semi': ['error', 'never'],
         'no-multiple-empty-lines': ['error', { max: 1 }],
         'max-len': 'off',
         'new-cap': ['error', {
@@ -42,4 +52,4 @@ module.exports = {
         }],
         'prefer-const': 'error',
     },
-}
+}

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,29 @@
+name: Bug report
+description: Create a bug report to help us address errors in the repository
+title: "[BUG] <bug description>"
+labels: [bug]
+body:
+  - type: textarea
+    id: bugdescription
+    attributes:
+      label: Description of the bug
+    validations:
+      required: true
+  - type: textarea
+    id: workingenvironment
+    attributes:
+      label: Working Environment (e.g. operating system, browser, device)
+    validations:
+      required: true
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Please add screenshots (if applicable)
+    validations:
+      required: false
+  - type: textarea
+    id: context
+    attributes:
+      label: Add any other context about the problem here
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,23 @@
+name: Ideas
+description: Have a new idea or feature request
+title: "[FEATURE REQUEST] <description here>"
+labels: [ideas]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description of feature request, idea
+    validations:
+      required: true
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Add (multiple) screenshot links (if applicable)
+    validations:
+      required: false
+  - type: textarea
+    id: context
+    attributes:
+      label: Add any other context about the feature request here
+    validations:
+      required: false

.github/pull_request_template.md

@@ -0,0 +1,35 @@
+name: pull request
+description: Create a pull request
+title: "[PULL REQUEST] <pull request details>"
+labels: [enhancement]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description of the changes, you have made.(Mention the issue number, it solves.)
+    validations:
+      required: true
+  - type: textarea
+    id: workingenvironment
+    attributes:
+      label: Mention if the changes are for any specific Working Environment (e.g. operating system, browser, device, N/A) 
+    validations:
+      required: true
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Please add some pictorial references to these changes, if applicable (Drag & Drop your ss below)
+    validations:
+      required: false
+  - type: textarea
+    id: solution
+    attributes:
+      label: Does your code changes make any other feature broke? (If Yes, State reason)
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Any other context or any note for reviewer, to add here regarding this change.
+    validations:
+      required: false

.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: continuos-integration-checks
+on:
+  push:
+    branches: [ main ]
+jobs:
+  continuos-integration:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Run eslint check
+        run: npm run lint
+

.gitignore

@@ -1,2 +1,3 @@
-node_modules
-.env
+.env
+/dist
+node_modules

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Sarthak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,14 @@
+# base-ts-express-server-setup
+
+
+ You can clone this repo and start building your restful API in typescript using  express.js
+
+``` 
+NOTE: Feedbacks for the scope of improvement and more code best practices are appreciated. 
+Raise an issue if facing error or bug. 
+``` 
+
+## Connnect with me here: 
+
+- [Twitter](https://twitter.com/sarthakjdev)<br>
+- [Linkedin](https://www.linkedin.com/in/sarthakjdev)

docker/.dockerignore

@@ -0,0 +1 @@
+node_modules/

docker/docker-compose.yaml

@@ -0,0 +1,17 @@
+version: '3.9'
+
+services:
+  postgres:
+    container_name: crossknot-api
+    image: postgres
+    environment:
+      - POSTGRES_USER=crossknot
+      - POSTGRES_DB=crossknot
+      - POSTGRES_PASSWORD=crossknot
+    volumes:
+      - crossknot-data:/var/lib/postressql/data 
+    ports:
+      - "5431:5432"
+
+volumes:
+  crossknot-data:

errors.log

@@ -0,0 +1,2 @@
+[2022-07-07T12:40:57.055Z] info: Server is listenning on 3000
+[2022-07-07T12:49:35.895Z] info: Server is listenning on 3000

index.ts

@@ -0,0 +1,24 @@
+import express from 'express'
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import dotenv from 'dotenv/config'
+import config from '@configs/config'
+import logger from '@utils/logger'
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import cors from 'cors'
+
+import ready from '@controllers/ready'
+// requiring routes files :
+import serverRoute from '@routes/index'
+
+const port = config.PORT || 5000
+
+const app = express()
+app.use(cors())
+app.use(express.urlencoded({ extended: true }))
+app.use(express.json())
+app.use('/', serverRoute)
+app.get('/', ready)
+
+app.listen(port, () => {
+    logger.info(`Server is listenning on ${port}`)
+})